bf_ruby2 1.2016.229
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +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
|
@@ -0,0 +1,641 @@
|
|
|
1
|
+
# BillForward::AnalyticsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080/RestAPI*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**get_account_debts**](AnalyticsApi.md#get_account_debts) | **POST** /analytics/payments/accounts/outstanding | Gets outstanding debts per account, within a date range.
|
|
8
|
+
[**get_account_ltv**](AnalyticsApi.md#get_account_ltv) | **GET** /analytics/account-ltv/{account-id}/{end-datetime} | Gets an account's life-time value, as of a given end date.
|
|
9
|
+
[**get_account_payments**](AnalyticsApi.md#get_account_payments) | **POST** /analytics/payments/accounts | Gets hourly payments per product, within a date range.
|
|
10
|
+
[**get_billforward_managed_payments**](AnalyticsApi.md#get_billforward_managed_payments) | **GET** /analytics/billforward-managed-payments/{start-datetime}/{end-datetime} | Gets all payments managed by BillForward, within a date range.
|
|
11
|
+
[**get_churn**](AnalyticsApi.md#get_churn) | **GET** /analytics/churn/{start-datetime}/{end-datetime} | Gets churn, within a date range.
|
|
12
|
+
[**get_debts**](AnalyticsApi.md#get_debts) | **GET** /analytics/payments/outstanding/{start-datetime}/{end-datetime} | Gets debts within a date range.
|
|
13
|
+
[**get_payments**](AnalyticsApi.md#get_payments) | **GET** /analytics/payments/{start-datetime}/{end-datetime} | Gets payments within a date range.
|
|
14
|
+
[**get_product_payments**](AnalyticsApi.md#get_product_payments) | **POST** /analytics/payments-per-product | Gets hourly payments per product, within a date range.
|
|
15
|
+
[**get_product_rate_plan_payments**](AnalyticsApi.md#get_product_rate_plan_payments) | **POST** /analytics/payments/product-rate-plan | Gets hourly payments per product, within a date range.
|
|
16
|
+
[**get_subscription_ltv**](AnalyticsApi.md#get_subscription_ltv) | **GET** /analytics/subscription-ltv/{subscription-id}/{end-datetime} | Gets a subscription's life-time value, as of a given end date.
|
|
17
|
+
[**get_upgrades**](AnalyticsApi.md#get_upgrades) | **GET** /analytics/upgrades/{start-datetime}/{end-datetime} | Gets upgrades, within a date range.
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
# **get_account_debts**
|
|
21
|
+
> AccountPaymentsResultPagedMetadata get_account_debts(debts_per_account)
|
|
22
|
+
|
|
23
|
+
Gets outstanding debts per account, within a date range.
|
|
24
|
+
|
|
25
|
+
{\"nickname\" : \"Get account debts\",\"response\" : \"getAccountDebts.html\"}
|
|
26
|
+
|
|
27
|
+
### Example
|
|
28
|
+
```ruby
|
|
29
|
+
# load the gem
|
|
30
|
+
require 'bf_ruby2'
|
|
31
|
+
|
|
32
|
+
api_instance = BillForward::AnalyticsApi.new
|
|
33
|
+
|
|
34
|
+
debts_per_account = BillForward::BillingEntityBase.new # BillingEntityBase | The payments-per-account object.
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
#Gets outstanding debts per account, within a date range.
|
|
39
|
+
result = api_instance.get_account_debts(debts_per_account)
|
|
40
|
+
p result
|
|
41
|
+
rescue BillForward::ApiError => e
|
|
42
|
+
puts "Exception when calling AnalyticsApi->get_account_debts: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
|
|
48
|
+
Name | Type | Description | Notes
|
|
49
|
+
------------- | ------------- | ------------- | -------------
|
|
50
|
+
**debts_per_account** | [**BillingEntityBase**](BillingEntityBase.md)| The payments-per-account object. |
|
|
51
|
+
|
|
52
|
+
### Return type
|
|
53
|
+
|
|
54
|
+
[**AccountPaymentsResultPagedMetadata**](AccountPaymentsResultPagedMetadata.md)
|
|
55
|
+
|
|
56
|
+
### Authorization
|
|
57
|
+
|
|
58
|
+
No authorization required
|
|
59
|
+
|
|
60
|
+
### HTTP request headers
|
|
61
|
+
|
|
62
|
+
- **Content-Type**: application/json
|
|
63
|
+
- **Accept**: application/json
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
# **get_account_ltv**
|
|
68
|
+
> AccountLTVResultPagedMetadata get_account_ltv(account_id, end_datetime, opts)
|
|
69
|
+
|
|
70
|
+
Gets an account's life-time value, as of a given end date.
|
|
71
|
+
|
|
72
|
+
{\"nickname\":\"Get account life-time value\",\"response\":\"getAccountLTV.html\"}
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
```ruby
|
|
76
|
+
# load the gem
|
|
77
|
+
require 'bf_ruby2'
|
|
78
|
+
|
|
79
|
+
api_instance = BillForward::AnalyticsApi.new
|
|
80
|
+
|
|
81
|
+
account_id = "account_id_example" # String | The id of the account.
|
|
82
|
+
|
|
83
|
+
end_datetime = "end_datetime_example" # String | The UTC DateTime specifying the end of the result period.
|
|
84
|
+
|
|
85
|
+
opts = {
|
|
86
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
87
|
+
offset: 0, # Integer | The offset from the first amendment to return.
|
|
88
|
+
records: 8766, # Integer | The maximum number of amendments to return.
|
|
89
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
90
|
+
order: "ASC" # String | The direction of any ordering, either ASC or DESC.
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
begin
|
|
94
|
+
#Gets an account's life-time value, as of a given end date.
|
|
95
|
+
result = api_instance.get_account_ltv(account_id, end_datetime, opts)
|
|
96
|
+
p result
|
|
97
|
+
rescue BillForward::ApiError => e
|
|
98
|
+
puts "Exception when calling AnalyticsApi->get_account_ltv: #{e}"
|
|
99
|
+
end
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Parameters
|
|
103
|
+
|
|
104
|
+
Name | Type | Description | Notes
|
|
105
|
+
------------- | ------------- | ------------- | -------------
|
|
106
|
+
**account_id** | **String**| The id of the account. |
|
|
107
|
+
**end_datetime** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
108
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
109
|
+
**offset** | **Integer**| The offset from the first amendment to return. | [optional] [default to 0]
|
|
110
|
+
**records** | **Integer**| The maximum number of amendments to return. | [optional] [default to 8766]
|
|
111
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
112
|
+
**order** | **String**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC]
|
|
113
|
+
|
|
114
|
+
### Return type
|
|
115
|
+
|
|
116
|
+
[**AccountLTVResultPagedMetadata**](AccountLTVResultPagedMetadata.md)
|
|
117
|
+
|
|
118
|
+
### Authorization
|
|
119
|
+
|
|
120
|
+
No authorization required
|
|
121
|
+
|
|
122
|
+
### HTTP request headers
|
|
123
|
+
|
|
124
|
+
- **Content-Type**: Not defined
|
|
125
|
+
- **Accept**: application/json
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
# **get_account_payments**
|
|
130
|
+
> AccountPaymentsResultPagedMetadata get_account_payments(payments_per_account)
|
|
131
|
+
|
|
132
|
+
Gets hourly payments per product, within a date range.
|
|
133
|
+
|
|
134
|
+
{\"nickname\" : \"Get payments per account\",\"response\" : \"getAccountPayments.html\"}
|
|
135
|
+
|
|
136
|
+
### Example
|
|
137
|
+
```ruby
|
|
138
|
+
# load the gem
|
|
139
|
+
require 'bf_ruby2'
|
|
140
|
+
|
|
141
|
+
api_instance = BillForward::AnalyticsApi.new
|
|
142
|
+
|
|
143
|
+
payments_per_account = BillForward::BillingEntityBase.new # BillingEntityBase | The payments-per-account object.
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
begin
|
|
147
|
+
#Gets hourly payments per product, within a date range.
|
|
148
|
+
result = api_instance.get_account_payments(payments_per_account)
|
|
149
|
+
p result
|
|
150
|
+
rescue BillForward::ApiError => e
|
|
151
|
+
puts "Exception when calling AnalyticsApi->get_account_payments: #{e}"
|
|
152
|
+
end
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
Name | Type | Description | Notes
|
|
158
|
+
------------- | ------------- | ------------- | -------------
|
|
159
|
+
**payments_per_account** | [**BillingEntityBase**](BillingEntityBase.md)| The payments-per-account object. |
|
|
160
|
+
|
|
161
|
+
### Return type
|
|
162
|
+
|
|
163
|
+
[**AccountPaymentsResultPagedMetadata**](AccountPaymentsResultPagedMetadata.md)
|
|
164
|
+
|
|
165
|
+
### Authorization
|
|
166
|
+
|
|
167
|
+
No authorization required
|
|
168
|
+
|
|
169
|
+
### HTTP request headers
|
|
170
|
+
|
|
171
|
+
- **Content-Type**: application/json
|
|
172
|
+
- **Accept**: application/json
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
# **get_billforward_managed_payments**
|
|
177
|
+
> BillforwardManagedPaymentsResultPagedMetadata get_billforward_managed_payments(start_datetime, end_datetime, opts)
|
|
178
|
+
|
|
179
|
+
Gets all payments managed by BillForward, within a date range.
|
|
180
|
+
|
|
181
|
+
{\"nickname\":\"Get managed payments\",\"response\":\"getManagedPayments.html\"}
|
|
182
|
+
|
|
183
|
+
### Example
|
|
184
|
+
```ruby
|
|
185
|
+
# load the gem
|
|
186
|
+
require 'bf_ruby2'
|
|
187
|
+
|
|
188
|
+
api_instance = BillForward::AnalyticsApi.new
|
|
189
|
+
|
|
190
|
+
start_datetime = "start_datetime_example" # String | The UTC DateTime specifying the start of the result period.
|
|
191
|
+
|
|
192
|
+
end_datetime = "end_datetime_example" # String | The UTC DateTime specifying the end of the result period.
|
|
193
|
+
|
|
194
|
+
opts = {
|
|
195
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
196
|
+
offset: 0, # Integer | The offset from the first amendment to return.
|
|
197
|
+
records: 8766, # Integer | The maximum number of amendments to return.
|
|
198
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
199
|
+
order: "ASC" # String | The direction of any ordering, either ASC or DESC.
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
begin
|
|
203
|
+
#Gets all payments managed by BillForward, within a date range.
|
|
204
|
+
result = api_instance.get_billforward_managed_payments(start_datetime, end_datetime, opts)
|
|
205
|
+
p result
|
|
206
|
+
rescue BillForward::ApiError => e
|
|
207
|
+
puts "Exception when calling AnalyticsApi->get_billforward_managed_payments: #{e}"
|
|
208
|
+
end
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Parameters
|
|
212
|
+
|
|
213
|
+
Name | Type | Description | Notes
|
|
214
|
+
------------- | ------------- | ------------- | -------------
|
|
215
|
+
**start_datetime** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
216
|
+
**end_datetime** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
217
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
218
|
+
**offset** | **Integer**| The offset from the first amendment to return. | [optional] [default to 0]
|
|
219
|
+
**records** | **Integer**| The maximum number of amendments to return. | [optional] [default to 8766]
|
|
220
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
221
|
+
**order** | **String**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC]
|
|
222
|
+
|
|
223
|
+
### Return type
|
|
224
|
+
|
|
225
|
+
[**BillforwardManagedPaymentsResultPagedMetadata**](BillforwardManagedPaymentsResultPagedMetadata.md)
|
|
226
|
+
|
|
227
|
+
### Authorization
|
|
228
|
+
|
|
229
|
+
No authorization required
|
|
230
|
+
|
|
231
|
+
### HTTP request headers
|
|
232
|
+
|
|
233
|
+
- **Content-Type**: Not defined
|
|
234
|
+
- **Accept**: application/json
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
# **get_churn**
|
|
239
|
+
> CassChurnResultPagedMetadata get_churn(start_datetime, end_datetime, opts)
|
|
240
|
+
|
|
241
|
+
Gets churn, within a date range.
|
|
242
|
+
|
|
243
|
+
{\"nickname\":\"Get churn\",\"response\":\"getChurn.html\"}
|
|
244
|
+
|
|
245
|
+
### Example
|
|
246
|
+
```ruby
|
|
247
|
+
# load the gem
|
|
248
|
+
require 'bf_ruby2'
|
|
249
|
+
|
|
250
|
+
api_instance = BillForward::AnalyticsApi.new
|
|
251
|
+
|
|
252
|
+
start_datetime = "start_datetime_example" # String | The UTC DateTime specifying the start of the result period.
|
|
253
|
+
|
|
254
|
+
end_datetime = "end_datetime_example" # String | The UTC DateTime specifying the end of the result period.
|
|
255
|
+
|
|
256
|
+
opts = {
|
|
257
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
258
|
+
offset: 0, # Integer | The offset from the first amendment to return.
|
|
259
|
+
records: 8766, # Integer | The maximum number of amendments to return.
|
|
260
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
261
|
+
order: "ASC" # String | The direction of any ordering, either ASC or DESC.
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
begin
|
|
265
|
+
#Gets churn, within a date range.
|
|
266
|
+
result = api_instance.get_churn(start_datetime, end_datetime, opts)
|
|
267
|
+
p result
|
|
268
|
+
rescue BillForward::ApiError => e
|
|
269
|
+
puts "Exception when calling AnalyticsApi->get_churn: #{e}"
|
|
270
|
+
end
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
### Parameters
|
|
274
|
+
|
|
275
|
+
Name | Type | Description | Notes
|
|
276
|
+
------------- | ------------- | ------------- | -------------
|
|
277
|
+
**start_datetime** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
278
|
+
**end_datetime** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
279
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
280
|
+
**offset** | **Integer**| The offset from the first amendment to return. | [optional] [default to 0]
|
|
281
|
+
**records** | **Integer**| The maximum number of amendments to return. | [optional] [default to 8766]
|
|
282
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
283
|
+
**order** | **String**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC]
|
|
284
|
+
|
|
285
|
+
### Return type
|
|
286
|
+
|
|
287
|
+
[**CassChurnResultPagedMetadata**](CassChurnResultPagedMetadata.md)
|
|
288
|
+
|
|
289
|
+
### Authorization
|
|
290
|
+
|
|
291
|
+
No authorization required
|
|
292
|
+
|
|
293
|
+
### HTTP request headers
|
|
294
|
+
|
|
295
|
+
- **Content-Type**: Not defined
|
|
296
|
+
- **Accept**: application/json
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
# **get_debts**
|
|
301
|
+
> DebtsResultPagedMetadata get_debts(start_datetime, end_datetime, opts)
|
|
302
|
+
|
|
303
|
+
Gets debts within a date range.
|
|
304
|
+
|
|
305
|
+
{\"nickname\":\"Get debts\",\"response\":\"getDebts.html\"}
|
|
306
|
+
|
|
307
|
+
### Example
|
|
308
|
+
```ruby
|
|
309
|
+
# load the gem
|
|
310
|
+
require 'bf_ruby2'
|
|
311
|
+
|
|
312
|
+
api_instance = BillForward::AnalyticsApi.new
|
|
313
|
+
|
|
314
|
+
start_datetime = "start_datetime_example" # String | The UTC DateTime specifying the start of the result period.
|
|
315
|
+
|
|
316
|
+
end_datetime = "end_datetime_example" # String | The UTC DateTime specifying the end of the result period.
|
|
317
|
+
|
|
318
|
+
opts = {
|
|
319
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
320
|
+
offset: 0, # Integer | The offset from the first amendment to return.
|
|
321
|
+
records: 8766, # Integer | The maximum number of amendments to return.
|
|
322
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
323
|
+
order: "ASC" # String | The direction of any ordering, either ASC or DESC.
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
begin
|
|
327
|
+
#Gets debts within a date range.
|
|
328
|
+
result = api_instance.get_debts(start_datetime, end_datetime, opts)
|
|
329
|
+
p result
|
|
330
|
+
rescue BillForward::ApiError => e
|
|
331
|
+
puts "Exception when calling AnalyticsApi->get_debts: #{e}"
|
|
332
|
+
end
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
### Parameters
|
|
336
|
+
|
|
337
|
+
Name | Type | Description | Notes
|
|
338
|
+
------------- | ------------- | ------------- | -------------
|
|
339
|
+
**start_datetime** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
340
|
+
**end_datetime** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
341
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
342
|
+
**offset** | **Integer**| The offset from the first amendment to return. | [optional] [default to 0]
|
|
343
|
+
**records** | **Integer**| The maximum number of amendments to return. | [optional] [default to 8766]
|
|
344
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
345
|
+
**order** | **String**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC]
|
|
346
|
+
|
|
347
|
+
### Return type
|
|
348
|
+
|
|
349
|
+
[**DebtsResultPagedMetadata**](DebtsResultPagedMetadata.md)
|
|
350
|
+
|
|
351
|
+
### Authorization
|
|
352
|
+
|
|
353
|
+
No authorization required
|
|
354
|
+
|
|
355
|
+
### HTTP request headers
|
|
356
|
+
|
|
357
|
+
- **Content-Type**: Not defined
|
|
358
|
+
- **Accept**: application/json
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
# **get_payments**
|
|
363
|
+
> CassPaymentResultPagedMetadata get_payments(start_datetime, end_datetime, opts)
|
|
364
|
+
|
|
365
|
+
Gets payments within a date range.
|
|
366
|
+
|
|
367
|
+
{\"nickname\":\"Get all payments\",\"response\":\"getPayments.html\"}
|
|
368
|
+
|
|
369
|
+
### Example
|
|
370
|
+
```ruby
|
|
371
|
+
# load the gem
|
|
372
|
+
require 'bf_ruby2'
|
|
373
|
+
|
|
374
|
+
api_instance = BillForward::AnalyticsApi.new
|
|
375
|
+
|
|
376
|
+
start_datetime = "start_datetime_example" # String | The UTC DateTime specifying the start of the result period.
|
|
377
|
+
|
|
378
|
+
end_datetime = "end_datetime_example" # String | The UTC DateTime specifying the end of the result period.
|
|
379
|
+
|
|
380
|
+
opts = {
|
|
381
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
382
|
+
offset: 0, # Integer | The offset from the first amendment to return.
|
|
383
|
+
records: 8766, # Integer | The maximum number of amendments to return.
|
|
384
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
385
|
+
order: "ASC" # String | The direction of any ordering, either ASC or DESC.
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
begin
|
|
389
|
+
#Gets payments within a date range.
|
|
390
|
+
result = api_instance.get_payments(start_datetime, end_datetime, opts)
|
|
391
|
+
p result
|
|
392
|
+
rescue BillForward::ApiError => e
|
|
393
|
+
puts "Exception when calling AnalyticsApi->get_payments: #{e}"
|
|
394
|
+
end
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
### Parameters
|
|
398
|
+
|
|
399
|
+
Name | Type | Description | Notes
|
|
400
|
+
------------- | ------------- | ------------- | -------------
|
|
401
|
+
**start_datetime** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
402
|
+
**end_datetime** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
403
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
404
|
+
**offset** | **Integer**| The offset from the first amendment to return. | [optional] [default to 0]
|
|
405
|
+
**records** | **Integer**| The maximum number of amendments to return. | [optional] [default to 8766]
|
|
406
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
407
|
+
**order** | **String**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC]
|
|
408
|
+
|
|
409
|
+
### Return type
|
|
410
|
+
|
|
411
|
+
[**CassPaymentResultPagedMetadata**](CassPaymentResultPagedMetadata.md)
|
|
412
|
+
|
|
413
|
+
### Authorization
|
|
414
|
+
|
|
415
|
+
No authorization required
|
|
416
|
+
|
|
417
|
+
### HTTP request headers
|
|
418
|
+
|
|
419
|
+
- **Content-Type**: Not defined
|
|
420
|
+
- **Accept**: application/json
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
# **get_product_payments**
|
|
425
|
+
> ProductPaymentsResultPagedMetadata get_product_payments(payments_per_product)
|
|
426
|
+
|
|
427
|
+
Gets hourly payments per product, within a date range.
|
|
428
|
+
|
|
429
|
+
{\"nickname\" : \"Get payments per product\",\"response\" : \"getProductPayments.html\"}
|
|
430
|
+
|
|
431
|
+
### Example
|
|
432
|
+
```ruby
|
|
433
|
+
# load the gem
|
|
434
|
+
require 'bf_ruby2'
|
|
435
|
+
|
|
436
|
+
api_instance = BillForward::AnalyticsApi.new
|
|
437
|
+
|
|
438
|
+
payments_per_product = BillForward::BillingEntityBase.new # BillingEntityBase | The payments-per-product object.
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
begin
|
|
442
|
+
#Gets hourly payments per product, within a date range.
|
|
443
|
+
result = api_instance.get_product_payments(payments_per_product)
|
|
444
|
+
p result
|
|
445
|
+
rescue BillForward::ApiError => e
|
|
446
|
+
puts "Exception when calling AnalyticsApi->get_product_payments: #{e}"
|
|
447
|
+
end
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
### Parameters
|
|
451
|
+
|
|
452
|
+
Name | Type | Description | Notes
|
|
453
|
+
------------- | ------------- | ------------- | -------------
|
|
454
|
+
**payments_per_product** | [**BillingEntityBase**](BillingEntityBase.md)| The payments-per-product object. |
|
|
455
|
+
|
|
456
|
+
### Return type
|
|
457
|
+
|
|
458
|
+
[**ProductPaymentsResultPagedMetadata**](ProductPaymentsResultPagedMetadata.md)
|
|
459
|
+
|
|
460
|
+
### Authorization
|
|
461
|
+
|
|
462
|
+
No authorization required
|
|
463
|
+
|
|
464
|
+
### HTTP request headers
|
|
465
|
+
|
|
466
|
+
- **Content-Type**: application/json
|
|
467
|
+
- **Accept**: application/json
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
# **get_product_rate_plan_payments**
|
|
472
|
+
> ProductRatePlanPaymentsResultPagedMetadata get_product_rate_plan_payments(payments_per_product_rate_plan)
|
|
473
|
+
|
|
474
|
+
Gets hourly payments per product, within a date range.
|
|
475
|
+
|
|
476
|
+
{\"nickname\" : \"Get payments per rate plan\",\"response\" : \"getRatePlanPayments.html\"}
|
|
477
|
+
|
|
478
|
+
### Example
|
|
479
|
+
```ruby
|
|
480
|
+
# load the gem
|
|
481
|
+
require 'bf_ruby2'
|
|
482
|
+
|
|
483
|
+
api_instance = BillForward::AnalyticsApi.new
|
|
484
|
+
|
|
485
|
+
payments_per_product_rate_plan = BillForward::BillingEntityBase.new # BillingEntityBase | The payments-per-product-rate-plan object.
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
begin
|
|
489
|
+
#Gets hourly payments per product, within a date range.
|
|
490
|
+
result = api_instance.get_product_rate_plan_payments(payments_per_product_rate_plan)
|
|
491
|
+
p result
|
|
492
|
+
rescue BillForward::ApiError => e
|
|
493
|
+
puts "Exception when calling AnalyticsApi->get_product_rate_plan_payments: #{e}"
|
|
494
|
+
end
|
|
495
|
+
```
|
|
496
|
+
|
|
497
|
+
### Parameters
|
|
498
|
+
|
|
499
|
+
Name | Type | Description | Notes
|
|
500
|
+
------------- | ------------- | ------------- | -------------
|
|
501
|
+
**payments_per_product_rate_plan** | [**BillingEntityBase**](BillingEntityBase.md)| The payments-per-product-rate-plan object. |
|
|
502
|
+
|
|
503
|
+
### Return type
|
|
504
|
+
|
|
505
|
+
[**ProductRatePlanPaymentsResultPagedMetadata**](ProductRatePlanPaymentsResultPagedMetadata.md)
|
|
506
|
+
|
|
507
|
+
### Authorization
|
|
508
|
+
|
|
509
|
+
No authorization required
|
|
510
|
+
|
|
511
|
+
### HTTP request headers
|
|
512
|
+
|
|
513
|
+
- **Content-Type**: application/json
|
|
514
|
+
- **Accept**: application/json
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
# **get_subscription_ltv**
|
|
519
|
+
> SubscriptionLTVResultPagedMetadata get_subscription_ltv(subscription_id, end_datetime, opts)
|
|
520
|
+
|
|
521
|
+
Gets a subscription's life-time value, as of a given end date.
|
|
522
|
+
|
|
523
|
+
{\"nickname\":\"Get sub life-time value\",\"response\":\"getSubscriptionLTV.html\"}
|
|
524
|
+
|
|
525
|
+
### Example
|
|
526
|
+
```ruby
|
|
527
|
+
# load the gem
|
|
528
|
+
require 'bf_ruby2'
|
|
529
|
+
|
|
530
|
+
api_instance = BillForward::AnalyticsApi.new
|
|
531
|
+
|
|
532
|
+
subscription_id = "subscription_id_example" # String | The id of the subscription.
|
|
533
|
+
|
|
534
|
+
end_datetime = "end_datetime_example" # String | The UTC DateTime specifying the end of the result period.
|
|
535
|
+
|
|
536
|
+
opts = {
|
|
537
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
538
|
+
offset: 0, # Integer | The offset from the first amendment to return.
|
|
539
|
+
records: 8766, # Integer | The maximum number of amendments to return.
|
|
540
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
541
|
+
order: "ASC" # String | The direction of any ordering, either ASC or DESC.
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
begin
|
|
545
|
+
#Gets a subscription's life-time value, as of a given end date.
|
|
546
|
+
result = api_instance.get_subscription_ltv(subscription_id, end_datetime, opts)
|
|
547
|
+
p result
|
|
548
|
+
rescue BillForward::ApiError => e
|
|
549
|
+
puts "Exception when calling AnalyticsApi->get_subscription_ltv: #{e}"
|
|
550
|
+
end
|
|
551
|
+
```
|
|
552
|
+
|
|
553
|
+
### Parameters
|
|
554
|
+
|
|
555
|
+
Name | Type | Description | Notes
|
|
556
|
+
------------- | ------------- | ------------- | -------------
|
|
557
|
+
**subscription_id** | **String**| The id of the subscription. |
|
|
558
|
+
**end_datetime** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
559
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
560
|
+
**offset** | **Integer**| The offset from the first amendment to return. | [optional] [default to 0]
|
|
561
|
+
**records** | **Integer**| The maximum number of amendments to return. | [optional] [default to 8766]
|
|
562
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
563
|
+
**order** | **String**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC]
|
|
564
|
+
|
|
565
|
+
### Return type
|
|
566
|
+
|
|
567
|
+
[**SubscriptionLTVResultPagedMetadata**](SubscriptionLTVResultPagedMetadata.md)
|
|
568
|
+
|
|
569
|
+
### Authorization
|
|
570
|
+
|
|
571
|
+
No authorization required
|
|
572
|
+
|
|
573
|
+
### HTTP request headers
|
|
574
|
+
|
|
575
|
+
- **Content-Type**: Not defined
|
|
576
|
+
- **Accept**: application/json
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
# **get_upgrades**
|
|
581
|
+
> CassUpgradeResultPagedMetadata get_upgrades(start_datetime, end_datetime, opts)
|
|
582
|
+
|
|
583
|
+
Gets upgrades, within a date range.
|
|
584
|
+
|
|
585
|
+
{\"nickname\":\"Get upgrades\",\"response\":\"getUpgrades.html\"}
|
|
586
|
+
|
|
587
|
+
### Example
|
|
588
|
+
```ruby
|
|
589
|
+
# load the gem
|
|
590
|
+
require 'bf_ruby2'
|
|
591
|
+
|
|
592
|
+
api_instance = BillForward::AnalyticsApi.new
|
|
593
|
+
|
|
594
|
+
start_datetime = "start_datetime_example" # String | The UTC DateTime specifying the start of the result period.
|
|
595
|
+
|
|
596
|
+
end_datetime = "end_datetime_example" # String | The UTC DateTime specifying the end of the result period.
|
|
597
|
+
|
|
598
|
+
opts = {
|
|
599
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
600
|
+
offset: 0, # Integer | The offset from the first amendment to return.
|
|
601
|
+
records: 8766, # Integer | The maximum number of amendments to return.
|
|
602
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
603
|
+
order: "ASC" # String | The direction of any ordering, either ASC or DESC.
|
|
604
|
+
}
|
|
605
|
+
|
|
606
|
+
begin
|
|
607
|
+
#Gets upgrades, within a date range.
|
|
608
|
+
result = api_instance.get_upgrades(start_datetime, end_datetime, opts)
|
|
609
|
+
p result
|
|
610
|
+
rescue BillForward::ApiError => e
|
|
611
|
+
puts "Exception when calling AnalyticsApi->get_upgrades: #{e}"
|
|
612
|
+
end
|
|
613
|
+
```
|
|
614
|
+
|
|
615
|
+
### Parameters
|
|
616
|
+
|
|
617
|
+
Name | Type | Description | Notes
|
|
618
|
+
------------- | ------------- | ------------- | -------------
|
|
619
|
+
**start_datetime** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
620
|
+
**end_datetime** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
621
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
622
|
+
**offset** | **Integer**| The offset from the first amendment to return. | [optional] [default to 0]
|
|
623
|
+
**records** | **Integer**| The maximum number of amendments to return. | [optional] [default to 8766]
|
|
624
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
625
|
+
**order** | **String**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC]
|
|
626
|
+
|
|
627
|
+
### Return type
|
|
628
|
+
|
|
629
|
+
[**CassUpgradeResultPagedMetadata**](CassUpgradeResultPagedMetadata.md)
|
|
630
|
+
|
|
631
|
+
### Authorization
|
|
632
|
+
|
|
633
|
+
No authorization required
|
|
634
|
+
|
|
635
|
+
### HTTP request headers
|
|
636
|
+
|
|
637
|
+
- **Content-Type**: Not defined
|
|
638
|
+
- **Accept**: application/json
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
data/docs/AuditEntry.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# BillForward::AuditEntry
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who made the change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
7
|
+
**id** | **String** | { \"description\" : \"ID of the audit-entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
8
|
+
**organization_id** | **String** | { \"description\" : \"ID of the organization associated with the audit-entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
9
|
+
**entity** | **String** | { \"description\" : \"The entity type.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
10
|
+
**entity_id** | **String** | { \"description\" : \"ID of the entity.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
11
|
+
**audit_action** | **String** | { \"description\" : \"update, insert\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
12
|
+
**field_changes** | **Array<String>** | { \"description\" : \"A description of the changes.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
13
|
+
**new_entity** | **Array<String>** | |
|
|
14
|
+
**state** | **String** | { \"description\" : \"The state of the audit entry.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
15
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# BillForward::AuditEntryPagedMetadata
|
|
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<AuditEntry>**](AuditEntry.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
13
|
+
|
|
14
|
+
|