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,215 @@
|
|
|
1
|
+
# BillForward::UnitofmeasureApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080/RestAPI*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_unit_of_measure**](UnitofmeasureApi.md#create_unit_of_measure) | **POST** /units-of-measure | Create a unit-of-measure.
|
|
8
|
+
[**get_all_units_of_measure**](UnitofmeasureApi.md#get_all_units_of_measure) | **GET** /units-of-measure | Returns a collection of all unit-of-measure objects. By default 10 values are returned. Records are returned in natural order.
|
|
9
|
+
[**get_unit_of_measure_by_id**](UnitofmeasureApi.md#get_unit_of_measure_by_id) | **GET** /units-of-measure/{unit-of-measure-identifier} | Returns a single unit-of-measure corresponding to the unique id or name specified.
|
|
10
|
+
[**update_unit_of_measure**](UnitofmeasureApi.md#update_unit_of_measure) | **PUT** /units-of-measure | Update a unit-of-measure.
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
# **create_unit_of_measure**
|
|
14
|
+
> UnitOfMeasurePagedMetadata create_unit_of_measure(unit_of_measure)
|
|
15
|
+
|
|
16
|
+
Create a unit-of-measure.
|
|
17
|
+
|
|
18
|
+
{\"nickname\":\"Create a new unit of measure\",\"request\":\"createUnitOfMeasureRequest.html\",\"response\":\"createUnitOfMeasureResponse.html\"}
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
```ruby
|
|
22
|
+
# load the gem
|
|
23
|
+
require 'bf_ruby2'
|
|
24
|
+
|
|
25
|
+
api_instance = BillForward::UnitofmeasureApi.new
|
|
26
|
+
|
|
27
|
+
unit_of_measure = BillForward::UnitOfMeasure.new # UnitOfMeasure | The unit-of-measure object to be created.
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
begin
|
|
31
|
+
#Create a unit-of-measure.
|
|
32
|
+
result = api_instance.create_unit_of_measure(unit_of_measure)
|
|
33
|
+
p result
|
|
34
|
+
rescue BillForward::ApiError => e
|
|
35
|
+
puts "Exception when calling UnitofmeasureApi->create_unit_of_measure: #{e}"
|
|
36
|
+
end
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Parameters
|
|
40
|
+
|
|
41
|
+
Name | Type | Description | Notes
|
|
42
|
+
------------- | ------------- | ------------- | -------------
|
|
43
|
+
**unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md)| The unit-of-measure object to be created. |
|
|
44
|
+
|
|
45
|
+
### Return type
|
|
46
|
+
|
|
47
|
+
[**UnitOfMeasurePagedMetadata**](UnitOfMeasurePagedMetadata.md)
|
|
48
|
+
|
|
49
|
+
### Authorization
|
|
50
|
+
|
|
51
|
+
No authorization required
|
|
52
|
+
|
|
53
|
+
### HTTP request headers
|
|
54
|
+
|
|
55
|
+
- **Content-Type**: application/json
|
|
56
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
# **get_all_units_of_measure**
|
|
61
|
+
> UnitOfMeasurePagedMetadata get_all_units_of_measure(opts)
|
|
62
|
+
|
|
63
|
+
Returns a collection of all unit-of-measure objects. By default 10 values are returned. Records are returned in natural order.
|
|
64
|
+
|
|
65
|
+
{\"nickname\":\"Get all units of measure\",\"response\":\"getUnitOfMeasureAll.html\"}
|
|
66
|
+
|
|
67
|
+
### Example
|
|
68
|
+
```ruby
|
|
69
|
+
# load the gem
|
|
70
|
+
require 'bf_ruby2'
|
|
71
|
+
|
|
72
|
+
api_instance = BillForward::UnitofmeasureApi.new
|
|
73
|
+
|
|
74
|
+
opts = {
|
|
75
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
76
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
77
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
78
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
79
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
80
|
+
include_retired: true # BOOLEAN | Whether retired products should be returned.
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
begin
|
|
84
|
+
#Returns a collection of all unit-of-measure objects. By default 10 values are returned. Records are returned in natural order.
|
|
85
|
+
result = api_instance.get_all_units_of_measure(opts)
|
|
86
|
+
p result
|
|
87
|
+
rescue BillForward::ApiError => e
|
|
88
|
+
puts "Exception when calling UnitofmeasureApi->get_all_units_of_measure: #{e}"
|
|
89
|
+
end
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Parameters
|
|
93
|
+
|
|
94
|
+
Name | Type | Description | Notes
|
|
95
|
+
------------- | ------------- | ------------- | -------------
|
|
96
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
97
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
98
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
99
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
100
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
101
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to true]
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
[**UnitOfMeasurePagedMetadata**](UnitOfMeasurePagedMetadata.md)
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
No authorization required
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: Not defined
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
# **get_unit_of_measure_by_id**
|
|
119
|
+
> UnitOfMeasurePagedMetadata get_unit_of_measure_by_id(unit_of_measure_identifier, opts)
|
|
120
|
+
|
|
121
|
+
Returns a single unit-of-measure corresponding to the unique id or name specified.
|
|
122
|
+
|
|
123
|
+
{\"nickname\":\"Retrieve an existing unit of measure\",\"response\":\"getUnitOfMeasureByID.html\"}
|
|
124
|
+
|
|
125
|
+
### Example
|
|
126
|
+
```ruby
|
|
127
|
+
# load the gem
|
|
128
|
+
require 'bf_ruby2'
|
|
129
|
+
|
|
130
|
+
api_instance = BillForward::UnitofmeasureApi.new
|
|
131
|
+
|
|
132
|
+
unit_of_measure_identifier = "unit_of_measure_identifier_example" # String | The unique id or name of the unit-of-measure.
|
|
133
|
+
|
|
134
|
+
opts = {
|
|
135
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
begin
|
|
139
|
+
#Returns a single unit-of-measure corresponding to the unique id or name specified.
|
|
140
|
+
result = api_instance.get_unit_of_measure_by_id(unit_of_measure_identifier, opts)
|
|
141
|
+
p result
|
|
142
|
+
rescue BillForward::ApiError => e
|
|
143
|
+
puts "Exception when calling UnitofmeasureApi->get_unit_of_measure_by_id: #{e}"
|
|
144
|
+
end
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Parameters
|
|
148
|
+
|
|
149
|
+
Name | Type | Description | Notes
|
|
150
|
+
------------- | ------------- | ------------- | -------------
|
|
151
|
+
**unit_of_measure_identifier** | **String**| The unique id or name of the unit-of-measure. |
|
|
152
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
153
|
+
|
|
154
|
+
### Return type
|
|
155
|
+
|
|
156
|
+
[**UnitOfMeasurePagedMetadata**](UnitOfMeasurePagedMetadata.md)
|
|
157
|
+
|
|
158
|
+
### Authorization
|
|
159
|
+
|
|
160
|
+
No authorization required
|
|
161
|
+
|
|
162
|
+
### HTTP request headers
|
|
163
|
+
|
|
164
|
+
- **Content-Type**: text/plain
|
|
165
|
+
- **Accept**: application/json
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
# **update_unit_of_measure**
|
|
170
|
+
> UnitOfMeasurePagedMetadata update_unit_of_measure(unit_of_measure)
|
|
171
|
+
|
|
172
|
+
Update a unit-of-measure.
|
|
173
|
+
|
|
174
|
+
{\"nickname\":\"Update a unit of measure\",\"request\":\"updateUnitOfMeasureRequest.html\",\"response\":\"updateUnitOfMeasureResponse.html\"}
|
|
175
|
+
|
|
176
|
+
### Example
|
|
177
|
+
```ruby
|
|
178
|
+
# load the gem
|
|
179
|
+
require 'bf_ruby2'
|
|
180
|
+
|
|
181
|
+
api_instance = BillForward::UnitofmeasureApi.new
|
|
182
|
+
|
|
183
|
+
unit_of_measure = BillForward::UnitOfMeasure.new # UnitOfMeasure | The unit-of-measure object to be updated.
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
begin
|
|
187
|
+
#Update a unit-of-measure.
|
|
188
|
+
result = api_instance.update_unit_of_measure(unit_of_measure)
|
|
189
|
+
p result
|
|
190
|
+
rescue BillForward::ApiError => e
|
|
191
|
+
puts "Exception when calling UnitofmeasureApi->update_unit_of_measure: #{e}"
|
|
192
|
+
end
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Parameters
|
|
196
|
+
|
|
197
|
+
Name | Type | Description | Notes
|
|
198
|
+
------------- | ------------- | ------------- | -------------
|
|
199
|
+
**unit_of_measure** | [**UnitOfMeasure**](UnitOfMeasure.md)| The unit-of-measure object to be updated. |
|
|
200
|
+
|
|
201
|
+
### Return type
|
|
202
|
+
|
|
203
|
+
[**UnitOfMeasurePagedMetadata**](UnitOfMeasurePagedMetadata.md)
|
|
204
|
+
|
|
205
|
+
### Authorization
|
|
206
|
+
|
|
207
|
+
No authorization required
|
|
208
|
+
|
|
209
|
+
### HTTP request headers
|
|
210
|
+
|
|
211
|
+
- **Content-Type**: application/json
|
|
212
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# BillForward::UpdateAddressRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | |
|
|
7
|
+
**profile_id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } |
|
|
8
|
+
**address_line1** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
9
|
+
**address_line2** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
10
|
+
**address_line3** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
11
|
+
**city** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
12
|
+
**province** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
13
|
+
**country** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
14
|
+
**postcode** | **String** | { \"description\" : \"ZIP code or postcode.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
15
|
+
**landline** | **String** | { \"description\" : \"Phone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
16
|
+
**primary_address** | **BOOLEAN** | { \"description\" : \"Is this the primary, default, address for the associated profile?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [default to false]
|
|
17
|
+
|
|
18
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# BillForward::UpdateComponentValueAmendment
|
|
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
|
+
**pricing_component_value_id** | **String** | { \"description\" : \"The consistent ID of the associated pricing-component-value.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
19
|
+
**pricing_component_value_change_id** | **String** | { \"description\" : \"The unique ID of the associated pricing-component-value-change.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
20
|
+
**pricing_component_id** | **String** | { \"description\" : \"The consistent ID of the associated pricing-component.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
21
|
+
**value** | **Integer** | { \"description\" : \"The new value of the pricing-component-value\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BillForward::UpdateProfileRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | | [optional]
|
|
7
|
+
**account_id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\"] } |
|
|
8
|
+
**organization_id** | **String** | { \"description\" : \"\", \"verbs\":[] } | [optional]
|
|
9
|
+
**email** | **String** | { \"description\" : \"E-mail address\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
10
|
+
**first_name** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
11
|
+
**last_name** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
12
|
+
**company_name** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
13
|
+
**logo_url** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
14
|
+
**addresses** | [**Array<Address>**](Address.md) | { \"description\" : \"Address associated with the profile\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
15
|
+
**mobile** | **String** | { \"description\" : \"Mobile telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
16
|
+
**landline** | **String** | { \"description\" : \"Home telephone number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
17
|
+
**fax** | **String** | { \"description\" : \"Fax number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
18
|
+
**dob** | **DateTime** | { \"description\" : \"Date of birth in YYYY-MM-DD format\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
19
|
+
**vat_number** | **String** | { \"description\" : \"VAT number\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
20
|
+
**additional_information** | **String** | { \"description\" : \"Any additional information\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# BillForward::UpdateRoleRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
7
|
+
**organization_id** | **String** | { \"description\" : \"\", \"verbs\":[\"\"] } | [optional]
|
|
8
|
+
**id** | **String** | { \"description\" : \"\", \"verbs\":[\"GET\", \"PUT\"] } |
|
|
9
|
+
**name** | **String** | { \"description\" : \"Friendly name of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional]
|
|
10
|
+
**description** | **String** | { \"description\" : \"Friendly description of the role.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional]
|
|
11
|
+
**default_role** | **BOOLEAN** | { \"description\" : \"If set this role will become the default role for the organization unsetting any existing role. Any accounts without an explicitly set role will have this applied.\", \"verbs\":[\"GET\",\"POST\",\"PUT\"] } | [optional] [default to false]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# BillForward::UpdateSubscriptionRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | {\"description\":\"ID of the Subscription you wish to update.\",\"verbs\":[\"POST\"]} |
|
|
7
|
+
**name** | **String** | {\"description\":\"New name to assign to the updated subscription. This is primarily for your benefit &mdash; for example, to enable you to identify subscriptions at a glance in the BillForward web interface (e.g. 'Customer 1425, guy@mail.com, Premium membership').\",\"verbs\":[\"POST\"]} | [optional]
|
|
8
|
+
**description** | **String** | {\"description\":\"New description to assign to the updated subscription. This is primarily for your benefit &mdash; for example, you could write here the mechanism through which you obtained this customer. (e.g. 'Customer obtained through Lazy Wednesdays promotion').\",\"verbs\":[\"POST\"]} | [optional]
|
|
9
|
+
**start** | **DateTime** | {\"description\":\"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should enter its first service period.\",\"verbs\":[\"POST\"]} | [optional]
|
|
10
|
+
**_end** | **DateTime** | {\"description\":\"[Can only be changed if subscription is still in Provisioned state] ISO 8601 UTC DateTime (e.g. 2015-06-16T11:58:41Z) describing the date at which the subscription should finish its first service period.\",\"verbs\":[\"POST\"]} | [optional]
|
|
11
|
+
**state** | **String** | {\"description\":\"[Can only be changed if subscription is still in Provisioned state] The state into which you wish to move the updated subscription.<br><span class=\\\"label label-default\\\">AwaitingPayment</span> &mdash; The subscription is activated. After `start` time is surpassed, it will begin service and raise its first invoice.\",\"verbs\":[\"POST\"]} | [optional]
|
|
12
|
+
**parent_id** | **String** | {\"description\":\"ID of a parent subscription which will collect the charges raised by this subscription. The parent becomes responsible for paying those charges.\",\"verbs\":[\"POST\"]} | [optional]
|
|
13
|
+
**aggregate_all_subscriptions_on_account** | **BOOLEAN** | {\"description\":\"Whether this subscription should become an 'aggregating subscription', collecting charges (starting now) from all other subscriptions (current and future) belonging to this BillForward Account.\",\"verbs\":[\"POST\"]} | [optional] [default to false]
|
|
14
|
+
**failed_payment_behaviour** | **String** | {\"default\":\"None\",\"description\":\"The action that should be taken, should an invoice for some subscription to this rate plan remain unpaid despite the dunning period's being exceeded.<br><span class=\\\"label label-default\\\">CancelSubscription</span> &mdash; Demotes the subscription to the `Failed` state as soon as the dunning period is exceeded.<br><span class=\\\"label label-default\\\">None</span> &mdash; The subscription is allowed to continue in the `AwaitingPayment` state indefinitely even if the dunning period is exceeded.For slow payment cycles &mdash; or when manual invoice remediation is common &mdash; <span class=\\\"label label-default\\\">None</span> is recommended.<br>In a heavily-automated SaaS environment, automatic cancellation via <span class=\\\"label label-default\\\">CancelSubscription</span> is recommended.\",\"verbs\":[\"POST\",\"PUT\",\"GET\"]} | [optional]
|
|
15
|
+
|
|
16
|
+
|
data/docs/Usage.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# BillForward::Usage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
7
|
+
**session_id** | **String** | { \"description\" : \"A (not guaranteed unique) identifier for the session from which this usage was generated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
8
|
+
**subscription_id** | **String** | { \"description\" : \"ID of the subscription to which this usage instance pertains.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
9
|
+
**pricing_component_id** | **String** | { \"description\" : \"The ID of the pricing component this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
10
|
+
**pricing_component_name** | **String** | { \"description\" : \"The name of the pricing component this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
11
|
+
**uom** | **String** | { \"description\" : \"The unit-of-measure that this usage is for.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
12
|
+
**organization_id** | **String** | { \"description\" : \"The organization associated with this usage instance.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
13
|
+
**usage_period** | **Integer** | { \"description\" : \"The usage period during which this usage occurred.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
14
|
+
**usage_duration** | **Integer** | { \"description\" : \"The amount of time over which usage occurred (in milliseconds?). Relevant for 'temporal' usage only.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
15
|
+
**usage_type** | **String** | { \"description\" : \"The type of usage ('Temporal' or 'Itemized').\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
16
|
+
**usage_value** | **Integer** | { \"description\" : \"The quantity of product consumed by this usage. Relevant for 'itemized' usage only.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
17
|
+
**detailed** | **BOOLEAN** | { \"description\" : \"Is this usage a detailed entry?\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional] [default to false]
|
|
18
|
+
**created_by** | **String** | { \"description\" : \"Some identifying information about who created this object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
19
|
+
**updated_by** | **String** | { \"description\" : \"Some identifying information about who updated this object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
20
|
+
**start** | **DateTime** | { \"description\" : \"The start date of this usage instance, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
21
|
+
**stop** | **DateTime** | { \"description\" : \"The end date of this usage instance, UTC DateTime\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
22
|
+
**updated** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was updated.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
23
|
+
**occurred_on** | **DateTime** | { \"description\" : \"The UTC DateTime when the usage occurred.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
24
|
+
**billing_date** | **DateTime** | { \"description\" : \"The UTC DateTime when the usage is to be billed.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
25
|
+
|
|
26
|
+
|
data/docs/UsageApi.md
ADDED
|
@@ -0,0 +1,296 @@
|
|
|
1
|
+
# BillForward::UsageApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080/RestAPI*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_usage_instance**](UsageApi.md#create_usage_instance) | **POST** /usage | Add usage
|
|
8
|
+
[**get_usage_by_id**](UsageApi.md#get_usage_by_id) | **GET** /usage/{subscription-id}/{period-id} | Retrieve by subscription and period
|
|
9
|
+
[**get_usage_by_subscription_id**](UsageApi.md#get_usage_by_subscription_id) | **GET** /usage/{subscription-id} | Retrieve by subscription
|
|
10
|
+
[**get_usage_by_subscription_id_uo_m_period_and_usage_type**](UsageApi.md#get_usage_by_subscription_id_uo_m_period_and_usage_type) | **GET** /usage/{subscription-id}/{uom}/{period-id}/{usage-type} | Retrieve by subscription, period and type
|
|
11
|
+
[**update_usage_instance**](UsageApi.md#update_usage_instance) | **PUT** /usage | Update usage
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# **create_usage_instance**
|
|
15
|
+
> UsagePagedMetadata create_usage_instance(usage)
|
|
16
|
+
|
|
17
|
+
Add usage
|
|
18
|
+
|
|
19
|
+
{\"nickname\":\"Add usage\",\"request\":\"createUsageRequest.html\",\"response\":\"createUsageResponse.html\"}
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
```ruby
|
|
23
|
+
# load the gem
|
|
24
|
+
require 'bf_ruby2'
|
|
25
|
+
|
|
26
|
+
api_instance = BillForward::UsageApi.new
|
|
27
|
+
|
|
28
|
+
usage = BillForward::CompoundUsage.new # CompoundUsage | An array of The 'Usage' objects to be created.
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
begin
|
|
32
|
+
#Add usage
|
|
33
|
+
result = api_instance.create_usage_instance(usage)
|
|
34
|
+
p result
|
|
35
|
+
rescue BillForward::ApiError => e
|
|
36
|
+
puts "Exception when calling UsageApi->create_usage_instance: #{e}"
|
|
37
|
+
end
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
Name | Type | Description | Notes
|
|
43
|
+
------------- | ------------- | ------------- | -------------
|
|
44
|
+
**usage** | [**CompoundUsage**](CompoundUsage.md)| An array of The 'Usage' objects to be created. |
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
[**UsagePagedMetadata**](UsagePagedMetadata.md)
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
No authorization required
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: application/json
|
|
57
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
# **get_usage_by_id**
|
|
62
|
+
> UsagePagedMetadata get_usage_by_id(subscription_id, period_id, opts)
|
|
63
|
+
|
|
64
|
+
Retrieve by subscription and period
|
|
65
|
+
|
|
66
|
+
{\"nickname\":\"Retrieve by subscription and period\",\"response\":\"getUsageForPeriod.html\"}
|
|
67
|
+
|
|
68
|
+
### Example
|
|
69
|
+
```ruby
|
|
70
|
+
# load the gem
|
|
71
|
+
require 'bf_ruby2'
|
|
72
|
+
|
|
73
|
+
api_instance = BillForward::UsageApi.new
|
|
74
|
+
|
|
75
|
+
subscription_id = "subscription_id_example" # String | The subscriptionID of the usage.
|
|
76
|
+
|
|
77
|
+
period_id = 56 # Integer | The periodID of the usage.
|
|
78
|
+
|
|
79
|
+
opts = {
|
|
80
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
81
|
+
offset: 0, # Integer | The offset from the first amendment to return.
|
|
82
|
+
records: 8766, # Integer | The maximum number of amendments to return.
|
|
83
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
84
|
+
order: "ASC" # String | The direction of any ordering, either ASC or DESC.
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
begin
|
|
88
|
+
#Retrieve by subscription and period
|
|
89
|
+
result = api_instance.get_usage_by_id(subscription_id, period_id, opts)
|
|
90
|
+
p result
|
|
91
|
+
rescue BillForward::ApiError => e
|
|
92
|
+
puts "Exception when calling UsageApi->get_usage_by_id: #{e}"
|
|
93
|
+
end
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
Name | Type | Description | Notes
|
|
99
|
+
------------- | ------------- | ------------- | -------------
|
|
100
|
+
**subscription_id** | **String**| The subscriptionID of the usage. |
|
|
101
|
+
**period_id** | **Integer**| The periodID of the usage. |
|
|
102
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
103
|
+
**offset** | **Integer**| The offset from the first amendment to return. | [optional] [default to 0]
|
|
104
|
+
**records** | **Integer**| The maximum number of amendments to return. | [optional] [default to 8766]
|
|
105
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
106
|
+
**order** | **String**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC]
|
|
107
|
+
|
|
108
|
+
### Return type
|
|
109
|
+
|
|
110
|
+
[**UsagePagedMetadata**](UsagePagedMetadata.md)
|
|
111
|
+
|
|
112
|
+
### Authorization
|
|
113
|
+
|
|
114
|
+
No authorization required
|
|
115
|
+
|
|
116
|
+
### HTTP request headers
|
|
117
|
+
|
|
118
|
+
- **Content-Type**: Not defined
|
|
119
|
+
- **Accept**: application/json
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
# **get_usage_by_subscription_id**
|
|
124
|
+
> UsagePagedMetadata get_usage_by_subscription_id(subscription_id, opts)
|
|
125
|
+
|
|
126
|
+
Retrieve by subscription
|
|
127
|
+
|
|
128
|
+
{\"nickname\":\"Retrieve by subscription\",\"response\":\"getUsage.html\"}
|
|
129
|
+
|
|
130
|
+
### Example
|
|
131
|
+
```ruby
|
|
132
|
+
# load the gem
|
|
133
|
+
require 'bf_ruby2'
|
|
134
|
+
|
|
135
|
+
api_instance = BillForward::UsageApi.new
|
|
136
|
+
|
|
137
|
+
subscription_id = "subscription_id_example" # String | The subscriptionID of the subscription whose Usage instances you wish to GET.
|
|
138
|
+
|
|
139
|
+
opts = {
|
|
140
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
141
|
+
offset: 0, # Integer | The offset from the first amendment to return.
|
|
142
|
+
records: 8766, # Integer | The maximum number of amendments to return.
|
|
143
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
144
|
+
order: "ASC" # String | The direction of any ordering, either ASC or DESC.
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
begin
|
|
148
|
+
#Retrieve by subscription
|
|
149
|
+
result = api_instance.get_usage_by_subscription_id(subscription_id, opts)
|
|
150
|
+
p result
|
|
151
|
+
rescue BillForward::ApiError => e
|
|
152
|
+
puts "Exception when calling UsageApi->get_usage_by_subscription_id: #{e}"
|
|
153
|
+
end
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Parameters
|
|
157
|
+
|
|
158
|
+
Name | Type | Description | Notes
|
|
159
|
+
------------- | ------------- | ------------- | -------------
|
|
160
|
+
**subscription_id** | **String**| The subscriptionID of the subscription whose Usage instances you wish to GET. |
|
|
161
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
162
|
+
**offset** | **Integer**| The offset from the first amendment to return. | [optional] [default to 0]
|
|
163
|
+
**records** | **Integer**| The maximum number of amendments to return. | [optional] [default to 8766]
|
|
164
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
165
|
+
**order** | **String**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC]
|
|
166
|
+
|
|
167
|
+
### Return type
|
|
168
|
+
|
|
169
|
+
[**UsagePagedMetadata**](UsagePagedMetadata.md)
|
|
170
|
+
|
|
171
|
+
### Authorization
|
|
172
|
+
|
|
173
|
+
No authorization required
|
|
174
|
+
|
|
175
|
+
### HTTP request headers
|
|
176
|
+
|
|
177
|
+
- **Content-Type**: Not defined
|
|
178
|
+
- **Accept**: application/json
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
# **get_usage_by_subscription_id_uo_m_period_and_usage_type**
|
|
183
|
+
> UsagePagedMetadata get_usage_by_subscription_id_uo_m_period_and_usage_type(subscription_id, uom, period_id, usage_type, opts)
|
|
184
|
+
|
|
185
|
+
Retrieve by subscription, period and type
|
|
186
|
+
|
|
187
|
+
{\"nickname\":\"Retrieve by subscription, period and type\",\"response\":\"getDetailedUsageForPeriod.html\"}
|
|
188
|
+
|
|
189
|
+
### Example
|
|
190
|
+
```ruby
|
|
191
|
+
# load the gem
|
|
192
|
+
require 'bf_ruby2'
|
|
193
|
+
|
|
194
|
+
api_instance = BillForward::UsageApi.new
|
|
195
|
+
|
|
196
|
+
subscription_id = "subscription_id_example" # String | The subscriptionID of the usage.
|
|
197
|
+
|
|
198
|
+
uom = "uom_example" # String | The uom of the usage.
|
|
199
|
+
|
|
200
|
+
period_id = 56 # Integer | The periodID of the usage.
|
|
201
|
+
|
|
202
|
+
usage_type = "usage_type_example" # String | The type of the usage.
|
|
203
|
+
|
|
204
|
+
opts = {
|
|
205
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
206
|
+
offset: 0, # Integer | The offset from the first amendment to return.
|
|
207
|
+
records: 8766, # Integer | The maximum number of amendments to return.
|
|
208
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
209
|
+
order: "ASC" # String | The direction of any ordering, either ASC or DESC.
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
begin
|
|
213
|
+
#Retrieve by subscription, period and type
|
|
214
|
+
result = api_instance.get_usage_by_subscription_id_uo_m_period_and_usage_type(subscription_id, uom, period_id, usage_type, opts)
|
|
215
|
+
p result
|
|
216
|
+
rescue BillForward::ApiError => e
|
|
217
|
+
puts "Exception when calling UsageApi->get_usage_by_subscription_id_uo_m_period_and_usage_type: #{e}"
|
|
218
|
+
end
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
### Parameters
|
|
222
|
+
|
|
223
|
+
Name | Type | Description | Notes
|
|
224
|
+
------------- | ------------- | ------------- | -------------
|
|
225
|
+
**subscription_id** | **String**| The subscriptionID of the usage. |
|
|
226
|
+
**uom** | **String**| The uom of the usage. |
|
|
227
|
+
**period_id** | **Integer**| The periodID of the usage. |
|
|
228
|
+
**usage_type** | **String**| The type of the usage. |
|
|
229
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
230
|
+
**offset** | **Integer**| The offset from the first amendment to return. | [optional] [default to 0]
|
|
231
|
+
**records** | **Integer**| The maximum number of amendments to return. | [optional] [default to 8766]
|
|
232
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
233
|
+
**order** | **String**| The direction of any ordering, either ASC or DESC. | [optional] [default to ASC]
|
|
234
|
+
|
|
235
|
+
### Return type
|
|
236
|
+
|
|
237
|
+
[**UsagePagedMetadata**](UsagePagedMetadata.md)
|
|
238
|
+
|
|
239
|
+
### Authorization
|
|
240
|
+
|
|
241
|
+
No authorization required
|
|
242
|
+
|
|
243
|
+
### HTTP request headers
|
|
244
|
+
|
|
245
|
+
- **Content-Type**: Not defined
|
|
246
|
+
- **Accept**: application/json
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
# **update_usage_instance**
|
|
251
|
+
> UsagePagedMetadata update_usage_instance(usage)
|
|
252
|
+
|
|
253
|
+
Update usage
|
|
254
|
+
|
|
255
|
+
{\"nickname\":\"Update usage\",\"request\":\"updateUsageRequest.html\",\"response\":\"updateUsageResponse.html\"}
|
|
256
|
+
|
|
257
|
+
### Example
|
|
258
|
+
```ruby
|
|
259
|
+
# load the gem
|
|
260
|
+
require 'bf_ruby2'
|
|
261
|
+
|
|
262
|
+
api_instance = BillForward::UsageApi.new
|
|
263
|
+
|
|
264
|
+
usage = BillForward::CompoundUsage.new # CompoundUsage | An array of The 'Usage' objects to be updated.
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
begin
|
|
268
|
+
#Update usage
|
|
269
|
+
result = api_instance.update_usage_instance(usage)
|
|
270
|
+
p result
|
|
271
|
+
rescue BillForward::ApiError => e
|
|
272
|
+
puts "Exception when calling UsageApi->update_usage_instance: #{e}"
|
|
273
|
+
end
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
### Parameters
|
|
277
|
+
|
|
278
|
+
Name | Type | Description | Notes
|
|
279
|
+
------------- | ------------- | ------------- | -------------
|
|
280
|
+
**usage** | [**CompoundUsage**](CompoundUsage.md)| An array of The 'Usage' objects to be updated. |
|
|
281
|
+
|
|
282
|
+
### Return type
|
|
283
|
+
|
|
284
|
+
[**UsagePagedMetadata**](UsagePagedMetadata.md)
|
|
285
|
+
|
|
286
|
+
### Authorization
|
|
287
|
+
|
|
288
|
+
No authorization required
|
|
289
|
+
|
|
290
|
+
### HTTP request headers
|
|
291
|
+
|
|
292
|
+
- **Content-Type**: application/json
|
|
293
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|