bf_ruby2 1.2016.229
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +201 -0
- data/README.md +824 -0
- data/bf_ruby2-1.0.0.gem +0 -0
- data/bf_ruby2.gemspec +55 -0
- data/docs/APIConfigurationPagedMetadata.md +14 -0
- data/docs/APIQuote.md +36 -0
- data/docs/APIQuotePagedMetadata.md +14 -0
- data/docs/APIQuoteResponseQuantity.md +25 -0
- data/docs/Account.md +21 -0
- data/docs/AccountLTVResultPagedMetadata.md +14 -0
- data/docs/AccountPagedMetadata.md +14 -0
- data/docs/AccountPaymentsResultPagedMetadata.md +14 -0
- data/docs/AccountsApi.md +1021 -0
- data/docs/AddChargeRequest.md +23 -0
- data/docs/AddCouponCodeRequest.md +11 -0
- data/docs/AddPaymentMethodRequest.md +8 -0
- data/docs/AddTaxationStrategyRequest.md +11 -0
- data/docs/Address.md +23 -0
- data/docs/AddressPagedMetadata.md +14 -0
- data/docs/AddressesApi.md +104 -0
- data/docs/AggregatingComponent.md +17 -0
- data/docs/Amendment.md +19 -0
- data/docs/AmendmentDiscardAmendment.md +20 -0
- data/docs/AmendmentPagedMetadata.md +14 -0
- data/docs/AmendmentPriceNTimePagedMetadata.md +14 -0
- data/docs/AmendmentsApi.md +639 -0
- data/docs/AnalyticsApi.md +641 -0
- data/docs/AuditEntry.md +17 -0
- data/docs/AuditEntryPagedMetadata.md +14 -0
- data/docs/AuditlogsApi.md +308 -0
- data/docs/AuthCaptureRequest.md +17 -0
- data/docs/AuthorizeNetTokenPagedMetadata.md +14 -0
- data/docs/BFError.md +11 -0
- data/docs/BFPermission.md +17 -0
- data/docs/BFPermissionPagedMetadata.md +14 -0
- data/docs/BankAccountVerificationPagedMetadata.md +14 -0
- data/docs/BillforwardManagedPaymentsResultPagedMetadata.md +14 -0
- data/docs/BillingEntityBase.md +8 -0
- data/docs/BraintreeAuthCaptureRequest.md +19 -0
- data/docs/BraintreeCaptureRequest.md +20 -0
- data/docs/BraintreeTokenPagedMetadata.md +14 -0
- data/docs/CancelSubscriptionRequest.md +14 -0
- data/docs/CancellationAmendment.md +24 -0
- data/docs/CassChurnResultPagedMetadata.md +14 -0
- data/docs/CassPaymentResultPagedMetadata.md +14 -0
- data/docs/CassUpgradeResultPagedMetadata.md +14 -0
- data/docs/ChargesApi.md +408 -0
- data/docs/Client.md +21 -0
- data/docs/ClientPagedMetadata.md +14 -0
- data/docs/ClientsApi.md +215 -0
- data/docs/ComponentChange.md +20 -0
- data/docs/ComponentCost.md +9 -0
- data/docs/CompoundUsage.md +11 -0
- data/docs/CompoundUsageSession.md +11 -0
- data/docs/ConfigurationsApi.md +221 -0
- data/docs/Coupon.md +32 -0
- data/docs/CouponBook.md +21 -0
- data/docs/CouponBookDefinition.md +24 -0
- data/docs/CouponBookDefinitionPagedMetadata.md +14 -0
- data/docs/CouponBookPagedMetadata.md +14 -0
- data/docs/CouponDefinition.md +26 -0
- data/docs/CouponDefinitionPagedMetadata.md +14 -0
- data/docs/CouponDiscount.md +18 -0
- data/docs/CouponDiscountEstimate.md +13 -0
- data/docs/CouponInstance.md +26 -0
- data/docs/CouponInstanceExistingValue.md +15 -0
- data/docs/CouponInstancePagedMetadata.md +14 -0
- data/docs/CouponModifierBase.md +22 -0
- data/docs/CouponModifierBasePagedMetadata.md +14 -0
- data/docs/CouponPagedMetadata.md +14 -0
- data/docs/CouponRule.md +24 -0
- data/docs/CouponRulePagedMetadata.md +14 -0
- data/docs/CouponUniqueCodesRequest.md +11 -0
- data/docs/CouponUniqueCodesResponse.md +10 -0
- data/docs/CouponUniqueCodesResponsePagedMetadata.md +14 -0
- data/docs/CouponWrapperResponse.md +13 -0
- data/docs/CouponbookApi.md +496 -0
- data/docs/CouponbookdefinitionApi.md +329 -0
- data/docs/CoupondefinitionApi.md +267 -0
- data/docs/CouponinstanceApi.md +578 -0
- data/docs/CouponmodifierApi.md +369 -0
- data/docs/CouponruleApi.md +269 -0
- data/docs/CouponsApi.md +456 -0
- data/docs/CreateAccountProfileRequest.md +20 -0
- data/docs/CreateAccountRequest.md +13 -0
- data/docs/CreateAddressRequest.md +17 -0
- data/docs/CreateAggregatingComponentRequest.md +10 -0
- data/docs/CreateAggregatingSubscriptionRequest.md +21 -0
- data/docs/CreateProfileAddressRequest.md +16 -0
- data/docs/CreateSubscriptionBatchRequest.md +10 -0
- data/docs/CreateSubscriptionChargeAmendment.md +29 -0
- data/docs/CreateSubscriptionRequest.md +26 -0
- data/docs/CreditAccountRequest.md +13 -0
- data/docs/CreditNote.md +21 -0
- data/docs/CreditNotePagedMetadata.md +14 -0
- data/docs/CreditSubscriptionRequest.md +12 -0
- data/docs/CreditnotesApi.md +339 -0
- data/docs/CybersourceTokenPagedMetadata.md +14 -0
- data/docs/CybersourcetokensApi.md +259 -0
- data/docs/DataSynchronisationAppConfigurationPagedMetadata.md +14 -0
- data/docs/DataSynchronisationConfiguration.md +20 -0
- data/docs/DataSynchronisationConfigurationPagedMetadata.md +14 -0
- data/docs/DataSynchronizationJobPagedMetadata.md +14 -0
- data/docs/DebtsResultPagedMetadata.md +14 -0
- data/docs/DunningLine.md +18 -0
- data/docs/DunningLinePagedMetadata.md +14 -0
- data/docs/DunninglinesApi.md +328 -0
- data/docs/DynamicMetadata.md +7 -0
- data/docs/Email.md +35 -0
- data/docs/EmailPagedMetadata.md +14 -0
- data/docs/EmailProvider.md +18 -0
- data/docs/EmailProviderPagedMetadata.md +14 -0
- data/docs/EmailSubscription.md +20 -0
- data/docs/EmailSubscriptionPagedMetadata.md +14 -0
- data/docs/EmailprovidersApi.md +221 -0
- data/docs/EmailsApi.md +164 -0
- data/docs/EmailsubscriptionsApi.md +273 -0
- data/docs/EndTrialAmendment.md +19 -0
- data/docs/Event.md +15 -0
- data/docs/EventData.md +9 -0
- data/docs/FileSham.md +7 -0
- data/docs/FixedTerm.md +24 -0
- data/docs/FixedTermDefinitionPagedMetadata.md +14 -0
- data/docs/FixedTermExpiryAmendment.md +20 -0
- data/docs/FixedTermPagedMetadata.md +14 -0
- data/docs/FixedtermdefinitionsApi.md +104 -0
- data/docs/FixedtermsApi.md +56 -0
- data/docs/FlatPricingComponent.md +32 -0
- data/docs/ImportInvoiceLine.md +16 -0
- data/docs/InsertableBillingEntity.md +21 -0
- data/docs/Invoice.md +54 -0
- data/docs/InvoiceChargeRequest.md +11 -0
- data/docs/InvoiceLine.md +38 -0
- data/docs/InvoiceLinePayment.md +36 -0
- data/docs/InvoiceLinePaymentPagedMetadata.md +14 -0
- data/docs/InvoiceNextExecutionAttemptAmendment.md +21 -0
- data/docs/InvoiceOutstandingChargesAmendment.md +20 -0
- data/docs/InvoicePagedMetadata.md +14 -0
- data/docs/InvoicePayment.md +22 -0
- data/docs/InvoiceRecalculationAmendment.md +23 -0
- data/docs/InvoiceRecalculationRequest.md +12 -0
- data/docs/InvoicesApi.md +2474 -0
- data/docs/IssueInvoiceAmendment.md +20 -0
- data/docs/MetadataApi.md +210 -0
- data/docs/MetadataKeyValuesPagedMetadata.md +14 -0
- data/docs/MigrationRequest.md +16 -0
- data/docs/ModelAlias.md +14 -0
- data/docs/MutableBillingEntity.md +27 -0
- data/docs/Notification.md +27 -0
- data/docs/NotificationPagedMetadata.md +14 -0
- data/docs/NotificationsApi.md +370 -0
- data/docs/Organization.md +21 -0
- data/docs/OrganizationPagedMetadata.md +14 -0
- data/docs/OrganizationsApi.md +378 -0
- data/docs/Password.md +14 -0
- data/docs/PasswordPagedMetadata.md +14 -0
- data/docs/PasswordResetRequest.md +8 -0
- data/docs/PasswordsApi.md +56 -0
- data/docs/PauseRequest.md +9 -0
- data/docs/Payment.md +24 -0
- data/docs/PaymentMethod.md +32 -0
- data/docs/PaymentMethodPagedMetadata.md +14 -0
- data/docs/PaymentMethodSubscriptionLink.md +17 -0
- data/docs/PaymentMethodSubscriptionLinkPagedMetadata.md +14 -0
- data/docs/PaymentPagedMetadata.md +14 -0
- data/docs/PaymentRetryRequest.md +9 -0
- data/docs/PaymentmethodsApi.md +445 -0
- data/docs/PaymentmethodsubscriptionlinksApi.md +107 -0
- data/docs/PaymentsApi.md +464 -0
- data/docs/PendingComponentValueChange.md +11 -0
- data/docs/Period.md +16 -0
- data/docs/PeriodPagedMetadata.md +14 -0
- data/docs/PeriodsApi.md +125 -0
- data/docs/PermissionActionEntityPagedMetadata.md +14 -0
- data/docs/PermissionResourceEntityPagedMetadata.md +14 -0
- data/docs/PermissionsApi.md +322 -0
- data/docs/PriceCalculationPagedMetadata.md +14 -0
- data/docs/PricingComponent.md +32 -0
- data/docs/PricingComponentCouponModifier.md +22 -0
- data/docs/PricingComponentMigrationValue.md +12 -0
- data/docs/PricingComponentPagedMetadata.md +14 -0
- data/docs/PricingComponentQuantityRequest.md +10 -0
- data/docs/PricingComponentTier.md +19 -0
- data/docs/PricingComponentTierPagedMetadata.md +14 -0
- data/docs/PricingComponentValue.md +20 -0
- data/docs/PricingComponentValueChangeAmendment.md +22 -0
- data/docs/PricingComponentValueChangePagedMetadata.md +14 -0
- data/docs/PricingComponentValueMigrationAmendmentMapping.md +16 -0
- data/docs/PricingComponentValuePagedMetadata.md +14 -0
- data/docs/PricingComponentValueRequest.md +12 -0
- data/docs/PricingComponentValueResponsePagedMetadata.md +14 -0
- data/docs/PricingcalculatorApi.md +152 -0
- data/docs/PricingcomponentsApi.md +339 -0
- data/docs/PricingcomponenttiersApi.md +281 -0
- data/docs/PricingcomponentvaluechangesApi.md +345 -0
- data/docs/PricingcomponentvaluesApi.md +287 -0
- data/docs/Product.md +25 -0
- data/docs/ProductCouponModifier.md +22 -0
- data/docs/ProductPagedMetadata.md +14 -0
- data/docs/ProductPaymentsResultPagedMetadata.md +14 -0
- data/docs/ProductRatePlan.md +39 -0
- data/docs/ProductRatePlanMigrationAmendment.md +27 -0
- data/docs/ProductRatePlanPagedMetadata.md +14 -0
- data/docs/ProductRatePlanPaymentsResultPagedMetadata.md +14 -0
- data/docs/ProductrateplansApi.md +786 -0
- data/docs/ProductsApi.md +493 -0
- data/docs/Profile.md +25 -0
- data/docs/ProfilePagedMetadata.md +14 -0
- data/docs/ProfilesApi.md +287 -0
- data/docs/QuoteRequest.md +24 -0
- data/docs/QuoteRequestValue.md +11 -0
- data/docs/QuotesApi.md +56 -0
- data/docs/RecalculateChargeRequest.md +15 -0
- data/docs/Receipt.md +36 -0
- data/docs/ReceiptPagedMetadata.md +14 -0
- data/docs/ReceiptsApi.md +421 -0
- data/docs/Refund.md +35 -0
- data/docs/RefundPagedMetadata.md +14 -0
- data/docs/RefundsApi.md +432 -0
- data/docs/ResumeRequest.md +10 -0
- data/docs/ResumeSubscriptionAmendment.md +19 -0
- data/docs/RevenueAttribution.md +31 -0
- data/docs/RevenueAttributionPagedMetadata.md +14 -0
- data/docs/ReviveSubscriptionRequest.md +8 -0
- data/docs/Role.md +19 -0
- data/docs/RolePagedMetadata.md +14 -0
- data/docs/RolesApi.md +327 -0
- data/docs/RuleSatisfaction.md +11 -0
- data/docs/SearchApi.md +70 -0
- data/docs/SearchResultPagedMetadata.md +14 -0
- data/docs/ServiceEndAmendment.md +19 -0
- data/docs/StripeACHTokenPagedMetadata.md +14 -0
- data/docs/StripeAuthCaptureRequest.md +20 -0
- data/docs/StripeObject.md +7 -0
- data/docs/StripeTokenPagedMetadata.md +14 -0
- data/docs/Subscription.md +47 -0
- data/docs/SubscriptionCancellationPagedMetadata.md +14 -0
- data/docs/SubscriptionCharge.md +32 -0
- data/docs/SubscriptionChargePagedMetadata.md +14 -0
- data/docs/SubscriptionLTVResultPagedMetadata.md +14 -0
- data/docs/SubscriptionPagedMetadata.md +14 -0
- data/docs/SubscriptionsApi.md +2841 -0
- data/docs/SwaggerTypeList.md +9 -0
- data/docs/SwaggerTypeListInv.md +8 -0
- data/docs/SwaggerTypeListSubs.md +9 -0
- data/docs/SynchAppConfigsApi.md +208 -0
- data/docs/SynchConfigsApi.md +317 -0
- data/docs/SynchJobsApi.md +421 -0
- data/docs/TaxationLinkPagedMetadata.md +14 -0
- data/docs/TaxationStrategyPagedMetadata.md +14 -0
- data/docs/TaxationlinksApi.md +339 -0
- data/docs/TaxationstrategiesApi.md +514 -0
- data/docs/TieredPricingComponent.md +32 -0
- data/docs/TieredVolumePricingComponent.md +32 -0
- data/docs/TimeApi.md +56 -0
- data/docs/TimeRequest.md +16 -0
- data/docs/TimeResponse.md +18 -0
- data/docs/TimeResponsePagedMetadata.md +14 -0
- data/docs/TimeZone.md +11 -0
- data/docs/TimerAmendment.md +26 -0
- data/docs/TokenizationApi.md +340 -0
- data/docs/TokenizationPreAuthPagedMetadata.md +14 -0
- data/docs/TrustCommerceTokenPagedMetadata.md +14 -0
- data/docs/UnitDiscount.md +11 -0
- data/docs/UnitOfMeasure.md +16 -0
- data/docs/UnitOfMeasureCouponModifier.md +22 -0
- data/docs/UnitOfMeasurePagedMetadata.md +14 -0
- data/docs/UnitofmeasureApi.md +215 -0
- data/docs/UpdateAddressRequest.md +18 -0
- data/docs/UpdateComponentValueAmendment.md +23 -0
- data/docs/UpdateProfileRequest.md +22 -0
- data/docs/UpdateRoleRequest.md +13 -0
- data/docs/UpdateSubscriptionRequest.md +16 -0
- data/docs/Usage.md +26 -0
- data/docs/UsageApi.md +296 -0
- data/docs/UsagePagedMetadata.md +14 -0
- data/docs/UsagePeriodPagedMetadata.md +14 -0
- data/docs/UsageRoundingStrategyPagedMetadata.md +14 -0
- data/docs/UsageSession.md +21 -0
- data/docs/UsageSessionPagedMetadata.md +14 -0
- data/docs/UsageperiodsApi.md +194 -0
- data/docs/UsageroundingstrategiesApi.md +228 -0
- data/docs/UsagesessionsApi.md +224 -0
- data/docs/User.md +21 -0
- data/docs/UserCreationRequest.md +17 -0
- data/docs/UserCreationResponsePagedMetadata.md +14 -0
- data/docs/UserPagedMetadata.md +14 -0
- data/docs/Username.md +13 -0
- data/docs/UsernamePagedMetadata.md +14 -0
- data/docs/UsernamesApi.md +56 -0
- data/docs/UsersApi.md +564 -0
- data/docs/VaultedgatewaysApi.md +648 -0
- data/docs/WebhookPagedMetadata.md +14 -0
- data/docs/WebhooksApi.md +366 -0
- data/git_push.sh +67 -0
- data/lib/bf_ruby2/api/accounts_api.rb +1257 -0
- data/lib/bf_ruby2/api/addresses_api.rb +148 -0
- data/lib/bf_ruby2/api/amendments_api.rb +819 -0
- data/lib/bf_ruby2/api/analytics_api.rb +815 -0
- data/lib/bf_ruby2/api/auditlogs_api.rb +410 -0
- data/lib/bf_ruby2/api/charges_api.rb +527 -0
- data/lib/bf_ruby2/api/clients_api.rb +282 -0
- data/lib/bf_ruby2/api/configurations_api.rb +298 -0
- data/lib/bf_ruby2/api/couponbook_api.rb +619 -0
- data/lib/bf_ruby2/api/couponbookdefinition_api.rb +420 -0
- data/lib/bf_ruby2/api/coupondefinition_api.rb +342 -0
- data/lib/bf_ruby2/api/couponinstance_api.rb +737 -0
- data/lib/bf_ruby2/api/couponmodifier_api.rb +456 -0
- data/lib/bf_ruby2/api/couponrule_api.rb +342 -0
- data/lib/bf_ruby2/api/coupons_api.rb +580 -0
- data/lib/bf_ruby2/api/creditnotes_api.rb +438 -0
- data/lib/bf_ruby2/api/cybersourcetokens_api.rb +330 -0
- data/lib/bf_ruby2/api/dunninglines_api.rb +422 -0
- data/lib/bf_ruby2/api/emailproviders_api.rb +288 -0
- data/lib/bf_ruby2/api/emails_api.rb +214 -0
- data/lib/bf_ruby2/api/emailsubscriptions_api.rb +364 -0
- data/lib/bf_ruby2/api/fixedtermdefinitions_api.rb +148 -0
- data/lib/bf_ruby2/api/fixedterms_api.rb +91 -0
- data/lib/bf_ruby2/api/invoices_api.rb +3066 -0
- data/lib/bf_ruby2/api/metadata_api.rb +266 -0
- data/lib/bf_ruby2/api/notifications_api.rb +480 -0
- data/lib/bf_ruby2/api/organizations_api.rb +476 -0
- data/lib/bf_ruby2/api/passwords_api.rb +91 -0
- data/lib/bf_ruby2/api/paymentmethods_api.rb +565 -0
- data/lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb +153 -0
- data/lib/bf_ruby2/api/payments_api.rb +601 -0
- data/lib/bf_ruby2/api/periods_api.rb +180 -0
- data/lib/bf_ruby2/api/permissions_api.rb +408 -0
- data/lib/bf_ruby2/api/pricingcalculator_api.rb +205 -0
- data/lib/bf_ruby2/api/pricingcomponents_api.rb +438 -0
- data/lib/bf_ruby2/api/pricingcomponenttiers_api.rb +369 -0
- data/lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb +447 -0
- data/lib/bf_ruby2/api/pricingcomponentvalues_api.rb +378 -0
- data/lib/bf_ruby2/api/productrateplans_api.rb +971 -0
- data/lib/bf_ruby2/api/products_api.rb +611 -0
- data/lib/bf_ruby2/api/profiles_api.rb +375 -0
- data/lib/bf_ruby2/api/quotes_api.rb +91 -0
- data/lib/bf_ruby2/api/receipts_api.rb +559 -0
- data/lib/bf_ruby2/api/refunds_api.rb +540 -0
- data/lib/bf_ruby2/api/roles_api.rb +421 -0
- data/lib/bf_ruby2/api/search_api.rb +109 -0
- data/lib/bf_ruby2/api/subscriptions_api.rb +3490 -0
- data/lib/bf_ruby2/api/synch_app_configs_api.rb +272 -0
- data/lib/bf_ruby2/api/synch_configs_api.rb +403 -0
- data/lib/bf_ruby2/api/synch_jobs_api.rb +535 -0
- data/lib/bf_ruby2/api/taxationlinks_api.rb +438 -0
- data/lib/bf_ruby2/api/taxationstrategies_api.rb +660 -0
- data/lib/bf_ruby2/api/time_api.rb +91 -0
- data/lib/bf_ruby2/api/tokenization_api.rb +431 -0
- data/lib/bf_ruby2/api/unitofmeasure_api.rb +282 -0
- data/lib/bf_ruby2/api/usage_api.rb +389 -0
- data/lib/bf_ruby2/api/usageperiods_api.rb +267 -0
- data/lib/bf_ruby2/api/usageroundingstrategies_api.rb +304 -0
- data/lib/bf_ruby2/api/usagesessions_api.rb +298 -0
- data/lib/bf_ruby2/api/usernames_api.rb +91 -0
- data/lib/bf_ruby2/api/users_api.rb +692 -0
- data/lib/bf_ruby2/api/vaultedgateways_api.rb +787 -0
- data/lib/bf_ruby2/api/webhooks_api.rb +461 -0
- data/lib/bf_ruby2/api_client.rb +378 -0
- data/lib/bf_ruby2/api_error.rb +47 -0
- data/lib/bf_ruby2/configuration.rb +207 -0
- data/lib/bf_ruby2/models/account.rb +335 -0
- data/lib/bf_ruby2/models/account_ltv_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/account_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/account_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/add_charge_request.rb +414 -0
- data/lib/bf_ruby2/models/add_coupon_code_request.rb +231 -0
- data/lib/bf_ruby2/models/add_payment_method_request.rb +200 -0
- data/lib/bf_ruby2/models/add_taxation_strategy_request.rb +230 -0
- data/lib/bf_ruby2/models/address.rb +359 -0
- data/lib/bf_ruby2/models/address_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/aggregating_component.rb +294 -0
- data/lib/bf_ruby2/models/amendment.rb +374 -0
- data/lib/bf_ruby2/models/amendment_discard_amendment.rb +385 -0
- data/lib/bf_ruby2/models/amendment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/amendment_price_n_time_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_quote.rb +525 -0
- data/lib/bf_ruby2/models/api_quote_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_quote_response_quantity.rb +405 -0
- data/lib/bf_ruby2/models/audit_entry.rb +359 -0
- data/lib/bf_ruby2/models/audit_entry_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/auth_capture_request.rb +337 -0
- data/lib/bf_ruby2/models/authorize_net_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/bank_account_verification_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/bf_error.rb +265 -0
- data/lib/bf_ruby2/models/bf_permission.rb +337 -0
- data/lib/bf_ruby2/models/bf_permission_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/billforward_managed_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/billing_entity_base.rb +200 -0
- data/lib/bf_ruby2/models/braintree_auth_capture_request.rb +358 -0
- data/lib/bf_ruby2/models/braintree_capture_request.rb +327 -0
- data/lib/bf_ruby2/models/braintree_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cancel_subscription_request.rb +301 -0
- data/lib/bf_ruby2/models/cancellation_amendment.rb +451 -0
- data/lib/bf_ruby2/models/cass_churn_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cass_payment_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cass_upgrade_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/client.rb +342 -0
- data/lib/bf_ruby2/models/client_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/component_change.rb +373 -0
- data/lib/bf_ruby2/models/component_cost.rb +208 -0
- data/lib/bf_ruby2/models/compound_usage.rb +234 -0
- data/lib/bf_ruby2/models/compound_usage_session.rb +233 -0
- data/lib/bf_ruby2/models/coupon.rb +484 -0
- data/lib/bf_ruby2/models/coupon_book.rb +342 -0
- data/lib/bf_ruby2/models/coupon_book_definition.rb +417 -0
- data/lib/bf_ruby2/models/coupon_book_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_book_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_definition.rb +454 -0
- data/lib/bf_ruby2/models/coupon_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_discount.rb +298 -0
- data/lib/bf_ruby2/models/coupon_discount_estimate.rb +258 -0
- data/lib/bf_ruby2/models/coupon_instance.rb +426 -0
- data/lib/bf_ruby2/models/coupon_instance_existing_value.rb +272 -0
- data/lib/bf_ruby2/models/coupon_instance_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_modifier_base.rb +410 -0
- data/lib/bf_ruby2/models/coupon_modifier_base_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_rule.rb +470 -0
- data/lib/bf_ruby2/models/coupon_rule_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_request.rb +232 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_response.rb +219 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_wrapper_response.rb +250 -0
- data/lib/bf_ruby2/models/create_account_profile_request.rb +323 -0
- data/lib/bf_ruby2/models/create_account_request.rb +248 -0
- data/lib/bf_ruby2/models/create_address_request.rb +298 -0
- data/lib/bf_ruby2/models/create_aggregating_component_request.rb +221 -0
- data/lib/bf_ruby2/models/create_aggregating_subscription_request.rb +393 -0
- data/lib/bf_ruby2/models/create_profile_address_request.rb +287 -0
- data/lib/bf_ruby2/models/create_subscription_batch_request.rb +222 -0
- data/lib/bf_ruby2/models/create_subscription_charge_amendment.rb +514 -0
- data/lib/bf_ruby2/models/create_subscription_request.rb +444 -0
- data/lib/bf_ruby2/models/credit_account_request.rb +252 -0
- data/lib/bf_ruby2/models/credit_note.rb +368 -0
- data/lib/bf_ruby2/models/credit_note_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/credit_subscription_request.rb +241 -0
- data/lib/bf_ruby2/models/cybersource_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronisation_app_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronisation_configuration.rb +362 -0
- data/lib/bf_ruby2/models/data_synchronisation_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronization_job_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/debts_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/dunning_line.rb +354 -0
- data/lib/bf_ruby2/models/dunning_line_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/dynamic_metadata.rb +190 -0
- data/lib/bf_ruby2/models/email.rb +518 -0
- data/lib/bf_ruby2/models/email_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/email_provider.rb +302 -0
- data/lib/bf_ruby2/models/email_provider_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/email_subscription.rb +364 -0
- data/lib/bf_ruby2/models/email_subscription_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/end_trial_amendment.rb +374 -0
- data/lib/bf_ruby2/models/event.rb +272 -0
- data/lib/bf_ruby2/models/event_data.rb +212 -0
- data/lib/bf_ruby2/models/file_sham.rb +190 -0
- data/lib/bf_ruby2/models/fixed_term.rb +419 -0
- data/lib/bf_ruby2/models/fixed_term_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/fixed_term_expiry_amendment.rb +385 -0
- data/lib/bf_ruby2/models/fixed_term_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/flat_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/import_invoice_line.rb +271 -0
- data/lib/bf_ruby2/models/insertable_billing_entity.rb +384 -0
- data/lib/bf_ruby2/models/invoice.rb +746 -0
- data/lib/bf_ruby2/models/invoice_charge_request.rb +267 -0
- data/lib/bf_ruby2/models/invoice_line.rb +575 -0
- data/lib/bf_ruby2/models/invoice_line_payment.rb +539 -0
- data/lib/bf_ruby2/models/invoice_line_payment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/invoice_next_execution_attempt_amendment.rb +398 -0
- data/lib/bf_ruby2/models/invoice_outstanding_charges_amendment.rb +385 -0
- data/lib/bf_ruby2/models/invoice_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/invoice_payment.rb +384 -0
- data/lib/bf_ruby2/models/invoice_recalculation_amendment.rb +444 -0
- data/lib/bf_ruby2/models/invoice_recalculation_request.rb +293 -0
- data/lib/bf_ruby2/models/issue_invoice_amendment.rb +385 -0
- data/lib/bf_ruby2/models/metadata_key_values_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/migration_request.rb +332 -0
- data/lib/bf_ruby2/models/model_alias.rb +266 -0
- data/lib/bf_ruby2/models/mutable_billing_entity.rb +472 -0
- data/lib/bf_ruby2/models/notification.rb +472 -0
- data/lib/bf_ruby2/models/notification_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/organization.rb +349 -0
- data/lib/bf_ruby2/models/organization_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/password.rb +266 -0
- data/lib/bf_ruby2/models/password_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/password_reset_request.rb +201 -0
- data/lib/bf_ruby2/models/pause_request.rb +210 -0
- data/lib/bf_ruby2/models/payment.rb +417 -0
- data/lib/bf_ruby2/models/payment_method.rb +487 -0
- data/lib/bf_ruby2/models/payment_method_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_method_subscription_link.rb +291 -0
- data/lib/bf_ruby2/models/payment_method_subscription_link_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_retry_request.rb +210 -0
- data/lib/bf_ruby2/models/pending_component_value_change.rb +226 -0
- data/lib/bf_ruby2/models/period.rb +330 -0
- data/lib/bf_ruby2/models/period_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/permission_action_entity_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/permission_resource_entity_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/price_calculation_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/pricing_component_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/pricing_component_migration_value.rb +242 -0
- data/lib/bf_ruby2/models/pricing_component_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_quantity_request.rb +220 -0
- data/lib/bf_ruby2/models/pricing_component_tier.rb +346 -0
- data/lib/bf_ruby2/models/pricing_component_tier_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value.rb +323 -0
- data/lib/bf_ruby2/models/pricing_component_value_change_amendment.rb +419 -0
- data/lib/bf_ruby2/models/pricing_component_value_change_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value_migration_amendment_mapping.rb +283 -0
- data/lib/bf_ruby2/models/pricing_component_value_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value_request.rb +288 -0
- data/lib/bf_ruby2/models/pricing_component_value_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product.rb +435 -0
- data/lib/bf_ruby2/models/product_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/product_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_rate_plan.rb +658 -0
- data/lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb +483 -0
- data/lib/bf_ruby2/models/product_rate_plan_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_rate_plan_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/profile.rb +378 -0
- data/lib/bf_ruby2/models/profile_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/quote_request.rb +431 -0
- data/lib/bf_ruby2/models/quote_request_value.rb +232 -0
- data/lib/bf_ruby2/models/recalculate_charge_request.rb +318 -0
- data/lib/bf_ruby2/models/receipt.rb +535 -0
- data/lib/bf_ruby2/models/receipt_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/refund.rb +535 -0
- data/lib/bf_ruby2/models/refund_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/resume_request.rb +222 -0
- data/lib/bf_ruby2/models/resume_subscription_amendment.rb +374 -0
- data/lib/bf_ruby2/models/revenue_attribution.rb +451 -0
- data/lib/bf_ruby2/models/revenue_attribution_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/revive_subscription_request.rb +200 -0
- data/lib/bf_ruby2/models/role.rb +318 -0
- data/lib/bf_ruby2/models/role_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/rule_satisfaction.rb +234 -0
- data/lib/bf_ruby2/models/search_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/service_end_amendment.rb +374 -0
- data/lib/bf_ruby2/models/stripe_ach_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/stripe_auth_capture_request.rb +367 -0
- data/lib/bf_ruby2/models/stripe_object.rb +190 -0
- data/lib/bf_ruby2/models/stripe_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription.rb +681 -0
- data/lib/bf_ruby2/models/subscription_cancellation_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_charge.rb +529 -0
- data/lib/bf_ruby2/models/subscription_charge_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_ltv_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/swagger_type_list.rb +210 -0
- data/lib/bf_ruby2/models/swagger_type_list_inv.rb +201 -0
- data/lib/bf_ruby2/models/swagger_type_list_subs.rb +212 -0
- data/lib/bf_ruby2/models/taxation_link_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/taxation_strategy_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/tiered_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/tiered_volume_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/time_request.rb +323 -0
- data/lib/bf_ruby2/models/time_response.rb +345 -0
- data/lib/bf_ruby2/models/time_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/time_zone.rb +226 -0
- data/lib/bf_ruby2/models/timer_amendment.rb +485 -0
- data/lib/bf_ruby2/models/tokenization_pre_auth_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/trust_commerce_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/unit_discount.rb +226 -0
- data/lib/bf_ruby2/models/unit_of_measure.rb +286 -0
- data/lib/bf_ruby2/models/unit_of_measure_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/unit_of_measure_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/update_address_request.rb +303 -0
- data/lib/bf_ruby2/models/update_component_value_amendment.rb +418 -0
- data/lib/bf_ruby2/models/update_profile_request.rb +342 -0
- data/lib/bf_ruby2/models/update_role_request.rb +253 -0
- data/lib/bf_ruby2/models/update_subscription_request.rb +328 -0
- data/lib/bf_ruby2/models/usage.rb +423 -0
- data/lib/bf_ruby2/models/usage_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_period_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_rounding_strategy_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_session.rb +368 -0
- data/lib/bf_ruby2/models/usage_session_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/user.rb +352 -0
- data/lib/bf_ruby2/models/user_creation_request.rb +302 -0
- data/lib/bf_ruby2/models/user_creation_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/user_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/username.rb +253 -0
- data/lib/bf_ruby2/models/username_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/webhook_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/version.rb +26 -0
- data/lib/bf_ruby2.rb +340 -0
- data/setup.scratch.rb +33 -0
- data/spec/api/accounts_api_spec.rb +318 -0
- data/spec/api/addresses_api_spec.rb +70 -0
- data/spec/api/amendments_api_spec.rb +220 -0
- data/spec/api/analytics_api_spec.rb +220 -0
- data/spec/api/auditlogs_api_spec.rb +131 -0
- data/spec/api/charges_api_spec.rb +156 -0
- data/spec/api/clients_api_spec.rb +100 -0
- data/spec/api/configurations_api_spec.rb +103 -0
- data/spec/api/couponbook_api_spec.rb +175 -0
- data/spec/api/couponbookdefinition_api_spec.rb +131 -0
- data/spec/api/coupondefinition_api_spec.rb +113 -0
- data/spec/api/couponinstance_api_spec.rb +203 -0
- data/spec/api/couponmodifier_api_spec.rb +138 -0
- data/spec/api/couponrule_api_spec.rb +113 -0
- data/spec/api/coupons_api_spec.rb +168 -0
- data/spec/api/creditnotes_api_spec.rb +135 -0
- data/spec/api/cybersourcetokens_api_spec.rb +109 -0
- data/spec/api/dunninglines_api_spec.rb +131 -0
- data/spec/api/emailproviders_api_spec.rb +102 -0
- data/spec/api/emails_api_spec.rb +85 -0
- data/spec/api/emailsubscriptions_api_spec.rb +115 -0
- data/spec/api/fixedtermdefinitions_api_spec.rb +70 -0
- data/spec/api/fixedterms_api_spec.rb +58 -0
- data/spec/api/invoices_api_spec.rb +727 -0
- data/spec/api/metadata_api_spec.rb +96 -0
- data/spec/api/notifications_api_spec.rb +148 -0
- data/spec/api/organizations_api_spec.rb +143 -0
- data/spec/api/passwords_api_spec.rb +58 -0
- data/spec/api/paymentmethods_api_spec.rb +163 -0
- data/spec/api/paymentmethodsubscriptionlinks_api_spec.rb +71 -0
- data/spec/api/payments_api_spec.rb +172 -0
- data/spec/api/periods_api_spec.rb +79 -0
- data/spec/api/permissions_api_spec.rb +127 -0
- data/spec/api/pricingcalculator_api_spec.rb +82 -0
- data/spec/api/pricingcomponents_api_spec.rb +136 -0
- data/spec/api/pricingcomponenttiers_api_spec.rb +120 -0
- data/spec/api/pricingcomponentvaluechanges_api_spec.rb +138 -0
- data/spec/api/pricingcomponentvalues_api_spec.rb +123 -0
- data/spec/api/productrateplans_api_spec.rb +254 -0
- data/spec/api/products_api_spec.rb +173 -0
- data/spec/api/profiles_api_spec.rb +122 -0
- data/spec/api/quotes_api_spec.rb +58 -0
- data/spec/api/receipts_api_spec.rb +164 -0
- data/spec/api/refunds_api_spec.rb +156 -0
- data/spec/api/roles_api_spec.rb +129 -0
- data/spec/api/search_api_spec.rb +64 -0
- data/spec/api/subscriptions_api_spec.rb +809 -0
- data/spec/api/synch_app_configs_api_spec.rb +96 -0
- data/spec/api/synch_configs_api_spec.rb +125 -0
- data/spec/api/synch_jobs_api_spec.rb +151 -0
- data/spec/api/taxationlinks_api_spec.rb +136 -0
- data/spec/api/taxationstrategies_api_spec.rb +185 -0
- data/spec/api/time_api_spec.rb +58 -0
- data/spec/api/tokenization_api_spec.rb +138 -0
- data/spec/api/unitofmeasure_api_spec.rb +100 -0
- data/spec/api/usage_api_spec.rb +125 -0
- data/spec/api/usageperiods_api_spec.rb +99 -0
- data/spec/api/usageroundingstrategies_api_spec.rb +106 -0
- data/spec/api/usagesessions_api_spec.rb +104 -0
- data/spec/api/usernames_api_spec.rb +58 -0
- data/spec/api/users_api_spec.rb +187 -0
- data/spec/api/vaultedgateways_api_spec.rb +206 -0
- data/spec/api/webhooks_api_spec.rb +138 -0
- data/spec/api_client_spec.rb +237 -0
- data/spec/configuration_spec.rb +53 -0
- data/spec/models/account_ltv_result_paged_metadata_spec.rb +89 -0
- data/spec/models/account_paged_metadata_spec.rb +89 -0
- data/spec/models/account_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/account_spec.rb +131 -0
- data/spec/models/add_charge_request_spec.rb +155 -0
- data/spec/models/add_coupon_code_request_spec.rb +71 -0
- data/spec/models/add_payment_method_request_spec.rb +53 -0
- data/spec/models/add_taxation_strategy_request_spec.rb +71 -0
- data/spec/models/address_paged_metadata_spec.rb +89 -0
- data/spec/models/address_spec.rb +143 -0
- data/spec/models/aggregating_component_spec.rb +107 -0
- data/spec/models/amendment_discard_amendment_spec.rb +137 -0
- data/spec/models/amendment_paged_metadata_spec.rb +89 -0
- data/spec/models/amendment_price_n_time_paged_metadata_spec.rb +89 -0
- data/spec/models/amendment_spec.rb +131 -0
- data/spec/models/api_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/api_quote_paged_metadata_spec.rb +89 -0
- data/spec/models/api_quote_response_quantity_spec.rb +159 -0
- data/spec/models/api_quote_spec.rb +225 -0
- data/spec/models/audit_entry_paged_metadata_spec.rb +89 -0
- data/spec/models/audit_entry_spec.rb +119 -0
- data/spec/models/auth_capture_request_spec.rb +115 -0
- data/spec/models/authorize_net_token_paged_metadata_spec.rb +89 -0
- data/spec/models/bank_account_verification_paged_metadata_spec.rb +89 -0
- data/spec/models/bf_error_spec.rb +75 -0
- data/spec/models/bf_permission_paged_metadata_spec.rb +89 -0
- data/spec/models/bf_permission_spec.rb +115 -0
- data/spec/models/billforward_managed_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/billing_entity_base_spec.rb +53 -0
- data/spec/models/braintree_auth_capture_request_spec.rb +127 -0
- data/spec/models/braintree_capture_request_spec.rb +125 -0
- data/spec/models/braintree_token_paged_metadata_spec.rb +89 -0
- data/spec/models/cancel_subscription_request_spec.rb +97 -0
- data/spec/models/cancellation_amendment_spec.rb +169 -0
- data/spec/models/cass_churn_result_paged_metadata_spec.rb +89 -0
- data/spec/models/cass_payment_result_paged_metadata_spec.rb +89 -0
- data/spec/models/cass_upgrade_result_paged_metadata_spec.rb +89 -0
- data/spec/models/client_paged_metadata_spec.rb +89 -0
- data/spec/models/client_spec.rb +131 -0
- data/spec/models/component_change_spec.rb +133 -0
- data/spec/models/component_cost_spec.rb +59 -0
- data/spec/models/compound_usage_session_spec.rb +71 -0
- data/spec/models/compound_usage_spec.rb +71 -0
- data/spec/models/coupon_book_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_book_definition_spec.rb +157 -0
- data/spec/models/coupon_book_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_book_spec.rb +131 -0
- data/spec/models/coupon_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_definition_spec.rb +173 -0
- data/spec/models/coupon_discount_estimate_spec.rb +83 -0
- data/spec/models/coupon_discount_spec.rb +113 -0
- data/spec/models/coupon_instance_existing_value_spec.rb +95 -0
- data/spec/models/coupon_instance_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_instance_spec.rb +165 -0
- data/spec/models/coupon_modifier_base_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_modifier_base_spec.rb +149 -0
- data/spec/models/coupon_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_rule_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_rule_spec.rb +173 -0
- data/spec/models/coupon_spec.rb +201 -0
- data/spec/models/coupon_unique_codes_request_spec.rb +71 -0
- data/spec/models/coupon_unique_codes_response_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_unique_codes_response_spec.rb +65 -0
- data/spec/models/coupon_wrapper_response_spec.rb +83 -0
- data/spec/models/create_account_profile_request_spec.rb +125 -0
- data/spec/models/create_account_request_spec.rb +83 -0
- data/spec/models/create_address_request_spec.rb +107 -0
- data/spec/models/create_aggregating_component_request_spec.rb +65 -0
- data/spec/models/create_aggregating_subscription_request_spec.rb +143 -0
- data/spec/models/create_profile_address_request_spec.rb +101 -0
- data/spec/models/create_subscription_batch_request_spec.rb +65 -0
- data/spec/models/create_subscription_charge_amendment_spec.rb +203 -0
- data/spec/models/create_subscription_request_spec.rb +173 -0
- data/spec/models/credit_account_request_spec.rb +83 -0
- data/spec/models/credit_note_paged_metadata_spec.rb +89 -0
- data/spec/models/credit_note_spec.rb +135 -0
- data/spec/models/credit_subscription_request_spec.rb +77 -0
- data/spec/models/cybersource_token_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_app_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_configuration_spec.rb +129 -0
- data/spec/models/data_synchronization_job_paged_metadata_spec.rb +89 -0
- data/spec/models/debts_result_paged_metadata_spec.rb +89 -0
- data/spec/models/dunning_line_paged_metadata_spec.rb +89 -0
- data/spec/models/dunning_line_spec.rb +121 -0
- data/spec/models/dynamic_metadata_spec.rb +47 -0
- data/spec/models/email_paged_metadata_spec.rb +89 -0
- data/spec/models/email_provider_paged_metadata_spec.rb +89 -0
- data/spec/models/email_provider_spec.rb +113 -0
- data/spec/models/email_spec.rb +223 -0
- data/spec/models/email_subscription_paged_metadata_spec.rb +89 -0
- data/spec/models/email_subscription_spec.rb +133 -0
- data/spec/models/end_trial_amendment_spec.rb +131 -0
- data/spec/models/event_data_spec.rb +59 -0
- data/spec/models/event_spec.rb +95 -0
- data/spec/models/file_sham_spec.rb +47 -0
- data/spec/models/fixed_term_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/fixed_term_expiry_amendment_spec.rb +137 -0
- data/spec/models/fixed_term_paged_metadata_spec.rb +89 -0
- data/spec/models/fixed_term_spec.rb +157 -0
- data/spec/models/flat_pricing_component_spec.rb +221 -0
- data/spec/models/import_invoice_line_spec.rb +101 -0
- data/spec/models/insertable_billing_entity_spec.rb +139 -0
- data/spec/models/invoice_charge_request_spec.rb +75 -0
- data/spec/models/invoice_line_payment_paged_metadata_spec.rb +89 -0
- data/spec/models/invoice_line_payment_spec.rb +225 -0
- data/spec/models/invoice_line_spec.rb +245 -0
- data/spec/models/invoice_next_execution_attempt_amendment_spec.rb +143 -0
- data/spec/models/invoice_outstanding_charges_amendment_spec.rb +137 -0
- data/spec/models/invoice_paged_metadata_spec.rb +89 -0
- data/spec/models/invoice_payment_spec.rb +141 -0
- data/spec/models/invoice_recalculation_amendment_spec.rb +163 -0
- data/spec/models/invoice_recalculation_request_spec.rb +85 -0
- data/spec/models/invoice_spec.rb +341 -0
- data/spec/models/issue_invoice_amendment_spec.rb +137 -0
- data/spec/models/metadata_key_values_paged_metadata_spec.rb +89 -0
- data/spec/models/migration_request_spec.rb +109 -0
- data/spec/models/model_alias_spec.rb +89 -0
- data/spec/models/mutable_billing_entity_spec.rb +183 -0
- data/spec/models/notification_paged_metadata_spec.rb +89 -0
- data/spec/models/notification_spec.rb +183 -0
- data/spec/models/organization_paged_metadata_spec.rb +89 -0
- data/spec/models/organization_spec.rb +131 -0
- data/spec/models/password_paged_metadata_spec.rb +89 -0
- data/spec/models/password_reset_request_spec.rb +53 -0
- data/spec/models/password_spec.rb +89 -0
- data/spec/models/pause_request_spec.rb +59 -0
- data/spec/models/payment_method_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_method_spec.rb +205 -0
- data/spec/models/payment_method_subscription_link_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_method_subscription_link_spec.rb +107 -0
- data/spec/models/payment_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_retry_request_spec.rb +59 -0
- data/spec/models/payment_spec.rb +157 -0
- data/spec/models/pending_component_value_change_spec.rb +71 -0
- data/spec/models/period_paged_metadata_spec.rb +89 -0
- data/spec/models/period_spec.rb +109 -0
- data/spec/models/permission_action_entity_paged_metadata_spec.rb +89 -0
- data/spec/models/permission_resource_entity_paged_metadata_spec.rb +89 -0
- data/spec/models/price_calculation_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_coupon_modifier_spec.rb +149 -0
- data/spec/models/pricing_component_migration_value_spec.rb +77 -0
- data/spec/models/pricing_component_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_quantity_request_spec.rb +65 -0
- data/spec/models/pricing_component_spec.rb +221 -0
- data/spec/models/pricing_component_tier_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_tier_spec.rb +123 -0
- data/spec/models/pricing_component_value_change_amendment_spec.rb +153 -0
- data/spec/models/pricing_component_value_change_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_migration_amendment_mapping_spec.rb +101 -0
- data/spec/models/pricing_component_value_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_request_spec.rb +85 -0
- data/spec/models/pricing_component_value_response_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_spec.rb +125 -0
- data/spec/models/product_coupon_modifier_spec.rb +149 -0
- data/spec/models/product_paged_metadata_spec.rb +89 -0
- data/spec/models/product_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_migration_amendment_spec.rb +187 -0
- data/spec/models/product_rate_plan_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_spec.rb +275 -0
- data/spec/models/product_spec.rb +167 -0
- data/spec/models/profile_paged_metadata_spec.rb +89 -0
- data/spec/models/profile_spec.rb +155 -0
- data/spec/models/quote_request_spec.rb +161 -0
- data/spec/models/quote_request_value_spec.rb +71 -0
- data/spec/models/recalculate_charge_request_spec.rb +103 -0
- data/spec/models/receipt_paged_metadata_spec.rb +89 -0
- data/spec/models/receipt_spec.rb +237 -0
- data/spec/models/refund_paged_metadata_spec.rb +89 -0
- data/spec/models/refund_spec.rb +227 -0
- data/spec/models/resume_request_spec.rb +65 -0
- data/spec/models/resume_subscription_amendment_spec.rb +131 -0
- data/spec/models/revenue_attribution_paged_metadata_spec.rb +89 -0
- data/spec/models/revenue_attribution_spec.rb +191 -0
- data/spec/models/revive_subscription_request_spec.rb +53 -0
- data/spec/models/role_paged_metadata_spec.rb +89 -0
- data/spec/models/role_spec.rb +119 -0
- data/spec/models/rule_satisfaction_spec.rb +71 -0
- data/spec/models/search_result_paged_metadata_spec.rb +89 -0
- data/spec/models/service_end_amendment_spec.rb +131 -0
- data/spec/models/stripe_ach_token_paged_metadata_spec.rb +89 -0
- data/spec/models/stripe_auth_capture_request_spec.rb +133 -0
- data/spec/models/stripe_object_spec.rb +47 -0
- data/spec/models/stripe_token_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_cancellation_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_charge_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_charge_spec.rb +217 -0
- data/spec/models/subscription_ltv_result_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_spec.rb +303 -0
- data/spec/models/swagger_type_list_inv_spec.rb +53 -0
- data/spec/models/swagger_type_list_spec.rb +59 -0
- data/spec/models/swagger_type_list_subs_spec.rb +59 -0
- data/spec/models/taxation_link_paged_metadata_spec.rb +89 -0
- data/spec/models/taxation_strategy_paged_metadata_spec.rb +89 -0
- data/spec/models/tiered_pricing_component_spec.rb +221 -0
- data/spec/models/tiered_volume_pricing_component_spec.rb +221 -0
- data/spec/models/time_request_spec.rb +105 -0
- data/spec/models/time_response_paged_metadata_spec.rb +89 -0
- data/spec/models/time_response_spec.rb +117 -0
- data/spec/models/time_zone_spec.rb +71 -0
- data/spec/models/timer_amendment_spec.rb +189 -0
- data/spec/models/tokenization_pre_auth_paged_metadata_spec.rb +89 -0
- data/spec/models/trust_commerce_token_paged_metadata_spec.rb +89 -0
- data/spec/models/unit_discount_spec.rb +71 -0
- data/spec/models/unit_of_measure_coupon_modifier_spec.rb +149 -0
- data/spec/models/unit_of_measure_paged_metadata_spec.rb +89 -0
- data/spec/models/unit_of_measure_spec.rb +101 -0
- data/spec/models/update_address_request_spec.rb +113 -0
- data/spec/models/update_component_value_amendment_spec.rb +155 -0
- data/spec/models/update_profile_request_spec.rb +137 -0
- data/spec/models/update_role_request_spec.rb +83 -0
- data/spec/models/update_subscription_request_spec.rb +109 -0
- data/spec/models/usage_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_period_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_rounding_strategy_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_session_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_session_spec.rb +135 -0
- data/spec/models/usage_spec.rb +165 -0
- data/spec/models/user_creation_request_spec.rb +107 -0
- data/spec/models/user_creation_response_paged_metadata_spec.rb +89 -0
- data/spec/models/user_paged_metadata_spec.rb +89 -0
- data/spec/models/user_spec.rb +131 -0
- data/spec/models/username_paged_metadata_spec.rb +89 -0
- data/spec/models/username_spec.rb +83 -0
- data/spec/models/webhook_paged_metadata_spec.rb +89 -0
- data/spec/spec_helper.rb +122 -0
- metadata +1401 -0
data/docs/FileSham.md
ADDED
data/docs/FixedTerm.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# BillForward::FixedTerm
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
7
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional]
|
|
8
|
+
**updated** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional]
|
|
9
|
+
**id** | **String** | id | [optional]
|
|
10
|
+
**subscription_id** | **String** | { \"description\" : \"subscriptionID\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
11
|
+
**organization_id** | **String** | { \"description\" : \"The ID of the organization associated with the amendment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
12
|
+
**fixed_term_definition_id** | **String** | { \"description\" : \"fixedTermDefinitionID\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
13
|
+
**fixed_term_definition** | [**MutableBillingEntity**](MutableBillingEntity.md) | |
|
|
14
|
+
**expiry_behaviour** | **String** | fixedTermExpiryBehaviour |
|
|
15
|
+
**state** | **String** | state |
|
|
16
|
+
**product_rate_plan_as_of_time** | **DateTime** | productRatePlanAsOfTime |
|
|
17
|
+
**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 |
|
|
18
|
+
**start_time** | **DateTime** | start_time |
|
|
19
|
+
**expiry_time** | **DateTime** | expiry_time |
|
|
20
|
+
**periods** | **Integer** | { \"description\" : \"The number of billing periods that this fixed term lasts for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
21
|
+
**fixed_term_number** | **Integer** | { \"description\" : \"The number of sequential fixed terms previous to this one for the subscription (i.e. zero indexed 'fixedTermCount').\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
22
|
+
**deleted** | **BOOLEAN** | { \"description\" : \"Is the fixedTerm deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to false]
|
|
23
|
+
|
|
24
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# BillForward::FixedTermDefinitionPagedMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**next_page** | **String** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
7
|
+
**current_page** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
8
|
+
**current_offset** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
9
|
+
**records_requested** | **Integer** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
10
|
+
**records_returned** | **Integer** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
11
|
+
**execution_time** | **Integer** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
12
|
+
**results** | [**Array<MutableBillingEntity>**](MutableBillingEntity.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# BillForward::FixedTermExpiryAmendment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
7
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional]
|
|
8
|
+
**updated** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional]
|
|
9
|
+
**type** | **String** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } |
|
|
10
|
+
**id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional]
|
|
11
|
+
**organization_id** | **String** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional]
|
|
12
|
+
**subscription_id** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
13
|
+
**amendment_type** | **String** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } |
|
|
14
|
+
**actioning_time** | **DateTime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
15
|
+
**actioned_time** | **DateTime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional]
|
|
16
|
+
**state** | **String** | 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 |
|
|
17
|
+
**deleted** | **BOOLEAN** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to false]
|
|
18
|
+
**fixed_term_id** | **String** | { \"description\" : \"ID of the fixed term to be expired by the amendment.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# BillForward::FixedTermPagedMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**next_page** | **String** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
7
|
+
**current_page** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
8
|
+
**current_offset** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
9
|
+
**records_requested** | **Integer** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
10
|
+
**records_returned** | **Integer** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
11
|
+
**execution_time** | **Integer** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
12
|
+
**results** | [**Array<FixedTerm>**](FixedTerm.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# BillForward::FixedtermdefinitionsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080/RestAPI*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_fixed_term_definition**](FixedtermdefinitionsApi.md#create_fixed_term_definition) | **POST** /fixed-term-definitions | Create
|
|
8
|
+
[**update_fixed_term_definition**](FixedtermdefinitionsApi.md#update_fixed_term_definition) | **PUT** /fixed-term-definitions | Update
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
# **create_fixed_term_definition**
|
|
12
|
+
> FixedTermDefinitionPagedMetadata create_fixed_term_definition(fixed_term_definiton)
|
|
13
|
+
|
|
14
|
+
Create
|
|
15
|
+
|
|
16
|
+
{\"nickname\":\"Create a new fixed term definition\",\"request\":\"createFixedTermDefinitionRequest.html\",\"response\":\"createFixedTermDefinitionResponse.html\"}
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
```ruby
|
|
20
|
+
# load the gem
|
|
21
|
+
require 'bf_ruby2'
|
|
22
|
+
|
|
23
|
+
api_instance = BillForward::FixedtermdefinitionsApi.new
|
|
24
|
+
|
|
25
|
+
fixed_term_definiton = BillForward::MutableBillingEntity.new # MutableBillingEntity | The fixed-term-definition object to be updated.
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
begin
|
|
29
|
+
#Create
|
|
30
|
+
result = api_instance.create_fixed_term_definition(fixed_term_definiton)
|
|
31
|
+
p result
|
|
32
|
+
rescue BillForward::ApiError => e
|
|
33
|
+
puts "Exception when calling FixedtermdefinitionsApi->create_fixed_term_definition: #{e}"
|
|
34
|
+
end
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
Name | Type | Description | Notes
|
|
40
|
+
------------- | ------------- | ------------- | -------------
|
|
41
|
+
**fixed_term_definiton** | [**MutableBillingEntity**](MutableBillingEntity.md)| The fixed-term-definition object to be updated. |
|
|
42
|
+
|
|
43
|
+
### Return type
|
|
44
|
+
|
|
45
|
+
[**FixedTermDefinitionPagedMetadata**](FixedTermDefinitionPagedMetadata.md)
|
|
46
|
+
|
|
47
|
+
### Authorization
|
|
48
|
+
|
|
49
|
+
No authorization required
|
|
50
|
+
|
|
51
|
+
### HTTP request headers
|
|
52
|
+
|
|
53
|
+
- **Content-Type**: application/json
|
|
54
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
# **update_fixed_term_definition**
|
|
59
|
+
> FixedTermDefinitionPagedMetadata update_fixed_term_definition(fixed_term_definiton)
|
|
60
|
+
|
|
61
|
+
Update
|
|
62
|
+
|
|
63
|
+
{\"nickname\":\"Update a fixed-term definition\",\"request\":\"updateFixedTermDefinitionRequest.html\",\"response\":\"updateFixedTermDefinitionResponse.html\"}
|
|
64
|
+
|
|
65
|
+
### Example
|
|
66
|
+
```ruby
|
|
67
|
+
# load the gem
|
|
68
|
+
require 'bf_ruby2'
|
|
69
|
+
|
|
70
|
+
api_instance = BillForward::FixedtermdefinitionsApi.new
|
|
71
|
+
|
|
72
|
+
fixed_term_definiton = BillForward::MutableBillingEntity.new # MutableBillingEntity | The fixed-term-definition object to be updated.
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
begin
|
|
76
|
+
#Update
|
|
77
|
+
result = api_instance.update_fixed_term_definition(fixed_term_definiton)
|
|
78
|
+
p result
|
|
79
|
+
rescue BillForward::ApiError => e
|
|
80
|
+
puts "Exception when calling FixedtermdefinitionsApi->update_fixed_term_definition: #{e}"
|
|
81
|
+
end
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### Parameters
|
|
85
|
+
|
|
86
|
+
Name | Type | Description | Notes
|
|
87
|
+
------------- | ------------- | ------------- | -------------
|
|
88
|
+
**fixed_term_definiton** | [**MutableBillingEntity**](MutableBillingEntity.md)| The fixed-term-definition object to be updated. |
|
|
89
|
+
|
|
90
|
+
### Return type
|
|
91
|
+
|
|
92
|
+
[**FixedTermDefinitionPagedMetadata**](FixedTermDefinitionPagedMetadata.md)
|
|
93
|
+
|
|
94
|
+
### Authorization
|
|
95
|
+
|
|
96
|
+
No authorization required
|
|
97
|
+
|
|
98
|
+
### HTTP request headers
|
|
99
|
+
|
|
100
|
+
- **Content-Type**: application/json
|
|
101
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# BillForward::FixedtermsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080/RestAPI*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**update_fixed_term**](FixedtermsApi.md#update_fixed_term) | **PUT** /fixed-terms | Update
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
# **update_fixed_term**
|
|
11
|
+
> FixedTermPagedMetadata update_fixed_term(payment_method)
|
|
12
|
+
|
|
13
|
+
Update
|
|
14
|
+
|
|
15
|
+
{\"nickname\":\"Update a fixed term\",\"request\":\"updateFixedTermRequest.html\",\"response\":\"updateFixedTermResponse.html\"}
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
```ruby
|
|
19
|
+
# load the gem
|
|
20
|
+
require 'bf_ruby2'
|
|
21
|
+
|
|
22
|
+
api_instance = BillForward::FixedtermsApi.new
|
|
23
|
+
|
|
24
|
+
payment_method = BillForward::FixedTerm.new # FixedTerm | The payment-method object to be updated.
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
begin
|
|
28
|
+
#Update
|
|
29
|
+
result = api_instance.update_fixed_term(payment_method)
|
|
30
|
+
p result
|
|
31
|
+
rescue BillForward::ApiError => e
|
|
32
|
+
puts "Exception when calling FixedtermsApi->update_fixed_term: #{e}"
|
|
33
|
+
end
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
Name | Type | Description | Notes
|
|
39
|
+
------------- | ------------- | ------------- | -------------
|
|
40
|
+
**payment_method** | [**FixedTerm**](FixedTerm.md)| The payment-method object to be updated. |
|
|
41
|
+
|
|
42
|
+
### Return type
|
|
43
|
+
|
|
44
|
+
[**FixedTermPagedMetadata**](FixedTermPagedMetadata.md)
|
|
45
|
+
|
|
46
|
+
### Authorization
|
|
47
|
+
|
|
48
|
+
No authorization required
|
|
49
|
+
|
|
50
|
+
### HTTP request headers
|
|
51
|
+
|
|
52
|
+
- **Content-Type**: application/json
|
|
53
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# BillForward::FlatPricingComponent
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
7
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional]
|
|
8
|
+
**updated** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional]
|
|
9
|
+
**type** | **String** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } |
|
|
10
|
+
**version_id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } |
|
|
11
|
+
**crm_id** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
12
|
+
**id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } When associating a pricing component with a product rate plan, this ID should be used. |
|
|
13
|
+
**product_rate_plan_id** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
14
|
+
**unit_of_measure_id** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
15
|
+
**organization_id** | **String** | { \"description\" : \"\", \"verbs\":[] } |
|
|
16
|
+
**name** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
17
|
+
**public_name** | **String** | {\"description\":\"A friendly non-unique name used to identify this pricing-component\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional]
|
|
18
|
+
**description** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
19
|
+
**charge_type** | **String** | { \"description\" : \"The charge type of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
20
|
+
**invoicing_type** | **String** | { \"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]
|
|
21
|
+
**charge_model** | **String** | { \"description\" : \"The charge model of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
22
|
+
**upgrade_mode** | **String** | {\"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]
|
|
23
|
+
**downgrade_mode** | **String** | {\"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]
|
|
24
|
+
**default_quantity** | **Integer** | { \"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\"] } |
|
|
25
|
+
**min_quantity** | **Integer** | { \"default\" : \"0\", \"description\" : \"The minimum quantity of the pricing-component.\", \"verbs\":[] } | [optional]
|
|
26
|
+
**max_quantity** | **Integer** | { \"description\" : \"The maximum quantity of the pricing-component.\", \"verbs\":[] } | [optional]
|
|
27
|
+
**valid_from** | **DateTime** | { \"default\" : \"current time\", \"description\" : \"The DateTime specifying when the pricing-component is valid from.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
28
|
+
**valid_till** | **DateTime** | { \"default\" : \"null\", \"description\" : \"The UTC DateTime specifying when the pricing-component is valid till.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
29
|
+
**tiers** | [**Array<PricingComponentTier>**](PricingComponentTier.md) | { \"default\" : \"[]\", \"description\" : \"The pricing-component-tiers associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
30
|
+
**unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md) | { \"description\" : \"The unit-of-measure associated with the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
31
|
+
|
|
32
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# BillForward::ImportInvoiceLine
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | | [optional]
|
|
7
|
+
**description** | **String** | | [optional]
|
|
8
|
+
**calculation** | **String** | | [optional]
|
|
9
|
+
**pricing_component** | **String** | | [optional]
|
|
10
|
+
**organization_id** | **String** | | [optional]
|
|
11
|
+
**cost** | **Float** | | [optional]
|
|
12
|
+
**tax** | **Float** | | [optional]
|
|
13
|
+
**period_start** | **DateTime** | | [optional]
|
|
14
|
+
**period_end** | **DateTime** | | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# BillForward::InsertableBillingEntity
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**applied** | **DateTime** | { \"description\" : \"The UTC DateTime when the pricing-component-value-change was processed.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
7
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
8
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional]
|
|
9
|
+
**id** | **String** | { \"description\" : \"ID of the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
10
|
+
**pricing_component_id** | **String** | { \"description\" : \"ID of the pricing-component associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
11
|
+
**unit_of_measure_id** | **String** | { \"description\" : \"ID of the unit-of-measure associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
12
|
+
**subscription_id** | **String** | { \"description\" : \"ID of the subscription associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
13
|
+
**invoice_id** | **String** | { \"description\" : \"ID of the invoice associated with the pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
14
|
+
**organization_id** | **String** | { \"description\" : \"The organizationID.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
15
|
+
**new_value** | **Integer** | { \"description\" : \"The new value of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
16
|
+
**old_value** | **Integer** | { \"description\" : \"The new value of the pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
17
|
+
**mode** | **String** | { \"description\" : \"The value change mode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
18
|
+
**state** | **String** | { \"description\" : \"The value change state.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
19
|
+
**as_of** | **DateTime** | { \"description\" : \"The UTC DateTime when the pricing-component-value-change was calculated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
20
|
+
|
|
21
|
+
|
data/docs/Invoice.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# BillForward::Invoice
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
7
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional]
|
|
8
|
+
**updated** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional]
|
|
9
|
+
**version_id** | **String** | { \"description\" : \"Version identifier of the invoice.\", \"verbs\":[\"GET\"] } | [optional]
|
|
10
|
+
**id** | **String** | { \"description\" : \"Unique identifier for the invoice.\", \"verbs\":[\"GET\"] } | [optional]
|
|
11
|
+
**crm_id** | **String** | { \"description\" : \"CRM identifier of the invoice.\", \"verbs\":[\"PUT\",\"GET\"] } | [optional]
|
|
12
|
+
**subscription_id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional]
|
|
13
|
+
**subscription_version_id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } |
|
|
14
|
+
**account_id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } |
|
|
15
|
+
**organization_id** | **String** | { \"description\" : \"\", \"verbs\":[] } |
|
|
16
|
+
**parent_invoice_id** | **String** | { \"description\" : \"\", \"verbs\":[] } | [optional]
|
|
17
|
+
**name** | **String** | { \"description\" : \"The name of the invoice\", \"verbs\":[] } | [optional]
|
|
18
|
+
**description** | **String** | { \"description\" : \"The description of the invoice\", \"verbs\":[] } | [optional]
|
|
19
|
+
**state** | **String** | { \"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\"] } |
|
|
20
|
+
**issued** | **DateTime** | { \"description\" : \"The UTC DateTime when the invoice was first issued.\", \"verbs\":[\"GET\"] } | [optional]
|
|
21
|
+
**period_start** | **DateTime** | { \"description\" : \"Start of the period being billed by this invoice, UTC DateTime\", \"verbs\":[\"GET\"] } | [optional]
|
|
22
|
+
**period_end** | **DateTime** | { \"description\" : \"End of the period being billed by this invoice, UTC DateTime.\", \"verbs\":[\"GET\"] } | [optional]
|
|
23
|
+
**due** | **DateTime** | { \"description\" : \"Date this invoice is due, UTC DateTime.\", \"verbs\":[\"GET\"] } | [optional]
|
|
24
|
+
**deleted** | **BOOLEAN** | { \"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]
|
|
25
|
+
**total_execution_attempts** | **Integer** | { \"description\" : \"Number of payment attempts for this invoice. This includes any manual execution attempts.\", \"verbs\":[\"GET\"] } | [optional]
|
|
26
|
+
**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]
|
|
27
|
+
**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]
|
|
28
|
+
**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]
|
|
29
|
+
**payment_received** | **DateTime** | { \"description\" : \"UTC DateTime specifying when payment was received for the invoice.\", \"verbs\":[\"GET\"] } | [optional]
|
|
30
|
+
**currency** | **String** | { \"description\" : \"Currency of the invoice specified by a three character ISO 4217 currency code.\", \"verbs\":[\"GET\"] } |
|
|
31
|
+
**cost_excluding_tax** | **Float** | { \"description\" : \"Cost of the invoice exclusive of tax.\", \"verbs\":[\"GET\"] } |
|
|
32
|
+
**invoice_cost** | **Float** | { \"description\" : \"Cost of the invoice inclusive of tax.\", \"verbs\":[\"GET\"] } |
|
|
33
|
+
**non_discounted_cost** | **Float** | Cost of the invoice before discounts, inclusive of tax. |
|
|
34
|
+
**non_discounted_cost_excluding_tax** | **Float** | Cost of the invoice before discounts, inclusive of tax. |
|
|
35
|
+
**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]
|
|
36
|
+
**discount_amount** | **Float** | { \"description\" : \"The amount of discounts for the invoice.\", \"verbs\":[\"GET\"] } | [optional]
|
|
37
|
+
**discount_amount_excluding_tax** | **Float** | { \"description\" : \"The amount of discounts for the invoice excluding tax.\", \"verbs\":[\"GET\"] } | [optional]
|
|
38
|
+
**invoice_refunded** | **Float** | { \"description\" : \"Total amount of the invoice refunded.\", \"verbs\":[\"GET\"] } | [optional]
|
|
39
|
+
**credit_rolled_over** | **Float** | { \"description\" : \"The amount of credit to be returned to the pool.\", \"verbs\":[\"GET\"] } |
|
|
40
|
+
**credit_rolled_over_excluding_tax** | **Float** | { \"description\" : \"The amount of credit to be returned to the pool excluding tax.\", \"verbs\":[\"GET\"] } | [optional]
|
|
41
|
+
**type** | **String** | { \"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\"] } |
|
|
42
|
+
**locked** | **String** | { \"description\" : \"If the subscription is locked, it will not be processed by the system\", \"verbs\":[] } | [optional]
|
|
43
|
+
**managed_by** | **String** | { \"description\" : \"Which system is responsible for managing the subscription.\", \"verbs\":[] } | [optional]
|
|
44
|
+
**initial_invoice** | **BOOLEAN** | { \"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]
|
|
45
|
+
**version_number** | **Integer** | { \"description\" : \"The version number of the Invoice. The first version of an Invoice is version number 1\", \"verbs\":[\"GET\"] } |
|
|
46
|
+
**invoice_lines** | [**Array<InvoiceLine>**](InvoiceLine.md) | { \"description\" : \"The collection of invoice-lines associated with the invoice.\", \"verbs\":[\"GET\"] } | [optional]
|
|
47
|
+
**tax_lines** | [**Array<InsertableBillingEntity>**](InsertableBillingEntity.md) | | [optional]
|
|
48
|
+
**invoice_payments** | [**Array<InvoicePayment>**](InvoicePayment.md) | { \"description\" : \"Payments used for this invoice. Multiple payments may be associated with the invoice.\", \"verbs\":[\"GET\"] } | [optional]
|
|
49
|
+
**invoice_refunds** | [**Array<Refund>**](Refund.md) | { \"description\" : \"Refunds associated with this invoice. Multiple refunds may be associated with the invoice.\", \"verbs\":[\"GET\"] } | [optional]
|
|
50
|
+
**invoice_credit_notes** | [**Array<CreditNote>**](CreditNote.md) | { \"description\" : \"Credit Notes associated with this invoice. Multiple credit notes may be associated with the invoice.\", \"verbs\":[\"GET\"] } | [optional]
|
|
51
|
+
**charges** | [**Array<SubscriptionCharge>**](SubscriptionCharge.md) | | [optional]
|
|
52
|
+
**children** | [**Array<Invoice>**](Invoice.md) | | [optional]
|
|
53
|
+
|
|
54
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# BillForward::InvoiceChargeRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
7
|
+
**include_aggregated** | **BOOLEAN** | {\"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]
|
|
8
|
+
**include_invoiced_charges_only** | **BOOLEAN** | {\"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]
|
|
9
|
+
**invoice_state** | **String** | {\"default\":null (invoice is raised in its default initial state),\"description\":\"Initial state with which any invoices will be generated.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
|
10
|
+
|
|
11
|
+
|
data/docs/InvoiceLine.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# BillForward::InvoiceLine
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md) | { \"description\" : \"The unit-of-measure associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
7
|
+
**pricing_component_type** | **String** | { \"description\" : \"The type of the pricing component associated with the invoice line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
8
|
+
**charge_type** | **String** | { \"description\" : \"charge-type.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
9
|
+
**period_start** | **DateTime** | The period start of the charge. |
|
|
10
|
+
**period_end** | **DateTime** | The period end of the charge. |
|
|
11
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
12
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional]
|
|
13
|
+
**updated** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional]
|
|
14
|
+
**id** | **String** | { \"description\" : \"ID of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
15
|
+
**invoice_id** | **String** | { \"description\" : \"invoice associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
16
|
+
**unit_of_measure_id** | **String** | { \"description\" : \"unit-of-measure associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
17
|
+
**subscription_id** | **String** | { \"description\" : \"the subscription ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
18
|
+
**product_rate_plan_id** | **String** | { \"description\" : \"the product rate plan ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
19
|
+
**public_product_rate_plan_name** | **String** | { \"description\" : \"the public product rate plan name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
20
|
+
**product_rate_plan_name** | **String** | { \"description\" : \"the product rate plan name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
21
|
+
**product_id** | **String** | { \"description\" : \"the product ID associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
22
|
+
**public_product_name** | **String** | { \"description\" : \"the public product name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
23
|
+
**product_name** | **String** | { \"description\" : \"the product name associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
24
|
+
**organization_id** | **String** | { \"description\" : \"ID of the organization associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
25
|
+
**name** | **String** | { \"description\" : \"The human readable name of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
26
|
+
**description** | **String** | { \"description\" : \"The human readable description of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
27
|
+
**calculation** | **String** | { \"description\" : \"A human readable explanation of how the value of the invoice-line was calculated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
28
|
+
**cost** | **Float** | { \"description\" : \"The cost of the invoice-line including tax.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
29
|
+
**tax** | **Float** | { \"description\" : \"The cumulative tax of the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
30
|
+
**component_value** | **Integer** | { \"description\" : \"The component value for the unit-of-measure that is associated with the invoice-line.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
31
|
+
**pricing_component_id** | **String** | The ID of the pricing-component that is associated with the invoice-line. |
|
|
32
|
+
**public_pricing_component_name** | **String** | The public name of the pricing-component that is associated with the invoice-line. |
|
|
33
|
+
**pricing_component_name** | **String** | The name of the pricing-component that is associated with the invoice-line. |
|
|
34
|
+
**subscription_charge_id** | **String** | The ID of the subscription-charge that is associated with the invoice-line. |
|
|
35
|
+
**child_invoice_id** | **String** | The ID of the invoice that is associated with the invoice-line. |
|
|
36
|
+
**type** | **String** | The type of the invoice-line. |
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# BillForward::InvoiceLinePayment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**period_start** | **DateTime** | {\"description\":\"PeriodStart of the charge with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
7
|
+
**period_end** | **DateTime** | {\"description\":\"PeriodEnd of the charge with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
8
|
+
**payment_received** | **DateTime** | {\"description\":\"The date when the associated payment was received.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
9
|
+
**refund_received** | **DateTime** | {\"description\":\"The date when the associated payment was refunded.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
10
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
11
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional]
|
|
12
|
+
**id** | **String** | {\"description\":\"ID of the InvoiceLinePayment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional]
|
|
13
|
+
**organization_id** | **String** | {\"description\":\"ID of the organization associated with the InvoiceLinePayment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
14
|
+
**payment_id** | **String** | {\"description\":\"ID of the Payment used upon this InvoiceLinePayment's invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
15
|
+
**gateway_original_payment_reference** | **String** | {\"description\":\"Reference with which the original payment transaction can be looked up in its gateway.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
16
|
+
**gateway_refund_payment_reference** | **String** | {\"description\":\"Reference with which the refund transaction for the payment can be looked up in its gateway.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
17
|
+
**aggregated_invoice_id** | **String** | {\"description\":\"ID of the invoice to which this InvoiceLinePayment's invoice line belongs.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
18
|
+
**aggregated_invoice_line_id** | **String** | {\"description\":\"ID of the invoice line toward which this InvoiceLinePayment contributes payment.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
19
|
+
**invoice_payment_id** | **String** | {\"description\":\"ID of the InvoicePayment with which this InvoiceLinePayment is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
20
|
+
**currency** | **String** | {\"description\":\"The currency of the payment &mdash; specified by a three-character ISO 4217 currency code.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
21
|
+
**gateway** | **String** | {\"description\":\"Payment gateway through which the payment was made.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
22
|
+
**nominal_amount** | **Float** | {\"description\":\"The amount paid &mdash; through credit or otherwise &mdash; toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
23
|
+
**actual_amount** | **Float** | {\"description\":\"The amount paid &mdash; through real money &mdash; toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
24
|
+
**refunded_amount** | **Float** | {\"description\":\"The monetary amount refunded toward this invoice line.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
25
|
+
**pricing_component_id** | **String** | {\"description\":\"ID of the PricingComponent with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
26
|
+
**pricing_component_name** | **String** | {\"description\":\"Name of the PricingComponent with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
27
|
+
**product_rate_plan_id** | **String** | {\"description\":\"ID of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
28
|
+
**product_rate_plan_name** | **String** | {\"description\":\"Internal name of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
29
|
+
**product_rate_plan_name_public** | **String** | {\"description\":\"Public name of the ProductRatePlan with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
30
|
+
**product_id** | **String** | {\"description\":\"ID of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
31
|
+
**product_name** | **String** | {\"description\":\"Internal name of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
32
|
+
**product_name_public** | **String** | {\"description\":\"Public name of the Product with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
33
|
+
**subscription_id** | **String** | {\"description\":\"ID of the Subscription with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
34
|
+
**account_id** | **String** | {\"description\":\"ID of the Account with which this InvoiceLinePayment's invoice line is associated.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} |
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# BillForward::InvoiceLinePaymentPagedMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**next_page** | **String** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
7
|
+
**current_page** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
8
|
+
**current_offset** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
9
|
+
**records_requested** | **Integer** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
10
|
+
**records_returned** | **Integer** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
11
|
+
**execution_time** | **Integer** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
12
|
+
**results** | [**Array<InvoiceLinePayment>**](InvoiceLinePayment.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# BillForward::InvoiceNextExecutionAttemptAmendment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
7
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional]
|
|
8
|
+
**updated** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional]
|
|
9
|
+
**type** | **String** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } |
|
|
10
|
+
**id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional]
|
|
11
|
+
**organization_id** | **String** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional]
|
|
12
|
+
**subscription_id** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
13
|
+
**amendment_type** | **String** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } |
|
|
14
|
+
**actioning_time** | **DateTime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
15
|
+
**actioned_time** | **DateTime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional]
|
|
16
|
+
**state** | **String** | 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 |
|
|
17
|
+
**deleted** | **BOOLEAN** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to false]
|
|
18
|
+
**invoice_id** | **String** | { \"description\" : \"ID of the Invoice to which the amendment pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
19
|
+
**force_paid** | **BOOLEAN** | { \"description\" : \"Create an offline payment and force the invoice into the paid state.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to false]
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# BillForward::InvoiceOutstandingChargesAmendment
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
7
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional]
|
|
8
|
+
**updated** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional]
|
|
9
|
+
**type** | **String** | { \"description\" : \"\", \"default\" : \"\", \"verbs\":[\"POST\",\"GET\"] } |
|
|
10
|
+
**id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } | [optional]
|
|
11
|
+
**organization_id** | **String** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional]
|
|
12
|
+
**subscription_id** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
13
|
+
**amendment_type** | **String** | { \"description\" : \"Type of amendment\", \"verbs\":[\"POST\",\"GET\"] } |
|
|
14
|
+
**actioning_time** | **DateTime** | { \"description\" : \"When the amendment will run\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
15
|
+
**actioned_time** | **DateTime** | { \"description\" : \"The time the amendment completed.\", \"verbs\":[\"GET\"] } | [optional]
|
|
16
|
+
**state** | **String** | 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 |
|
|
17
|
+
**deleted** | **BOOLEAN** | { \"description\" : \"Is the amendment deleted.\", \"verbs\":[\"GET\"] } | [default to false]
|
|
18
|
+
**invoice_id** | **String** | { \"description\" : \"ID of the Invoice with which the amendment is associated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# BillForward::InvoicePagedMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**next_page** | **String** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
7
|
+
**current_page** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
8
|
+
**current_offset** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
9
|
+
**records_requested** | **Integer** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
10
|
+
**records_returned** | **Integer** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
11
|
+
**execution_time** | **Integer** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
12
|
+
**results** | [**Array<Invoice>**](Invoice.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
13
|
+
|
|
14
|
+
|