bf_ruby2 1.2016.229
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +201 -0
- data/README.md +824 -0
- data/bf_ruby2-1.0.0.gem +0 -0
- data/bf_ruby2.gemspec +55 -0
- data/docs/APIConfigurationPagedMetadata.md +14 -0
- data/docs/APIQuote.md +36 -0
- data/docs/APIQuotePagedMetadata.md +14 -0
- data/docs/APIQuoteResponseQuantity.md +25 -0
- data/docs/Account.md +21 -0
- data/docs/AccountLTVResultPagedMetadata.md +14 -0
- data/docs/AccountPagedMetadata.md +14 -0
- data/docs/AccountPaymentsResultPagedMetadata.md +14 -0
- data/docs/AccountsApi.md +1021 -0
- data/docs/AddChargeRequest.md +23 -0
- data/docs/AddCouponCodeRequest.md +11 -0
- data/docs/AddPaymentMethodRequest.md +8 -0
- data/docs/AddTaxationStrategyRequest.md +11 -0
- data/docs/Address.md +23 -0
- data/docs/AddressPagedMetadata.md +14 -0
- data/docs/AddressesApi.md +104 -0
- data/docs/AggregatingComponent.md +17 -0
- data/docs/Amendment.md +19 -0
- data/docs/AmendmentDiscardAmendment.md +20 -0
- data/docs/AmendmentPagedMetadata.md +14 -0
- data/docs/AmendmentPriceNTimePagedMetadata.md +14 -0
- data/docs/AmendmentsApi.md +639 -0
- data/docs/AnalyticsApi.md +641 -0
- data/docs/AuditEntry.md +17 -0
- data/docs/AuditEntryPagedMetadata.md +14 -0
- data/docs/AuditlogsApi.md +308 -0
- data/docs/AuthCaptureRequest.md +17 -0
- data/docs/AuthorizeNetTokenPagedMetadata.md +14 -0
- data/docs/BFError.md +11 -0
- data/docs/BFPermission.md +17 -0
- data/docs/BFPermissionPagedMetadata.md +14 -0
- data/docs/BankAccountVerificationPagedMetadata.md +14 -0
- data/docs/BillforwardManagedPaymentsResultPagedMetadata.md +14 -0
- data/docs/BillingEntityBase.md +8 -0
- data/docs/BraintreeAuthCaptureRequest.md +19 -0
- data/docs/BraintreeCaptureRequest.md +20 -0
- data/docs/BraintreeTokenPagedMetadata.md +14 -0
- data/docs/CancelSubscriptionRequest.md +14 -0
- data/docs/CancellationAmendment.md +24 -0
- data/docs/CassChurnResultPagedMetadata.md +14 -0
- data/docs/CassPaymentResultPagedMetadata.md +14 -0
- data/docs/CassUpgradeResultPagedMetadata.md +14 -0
- data/docs/ChargesApi.md +408 -0
- data/docs/Client.md +21 -0
- data/docs/ClientPagedMetadata.md +14 -0
- data/docs/ClientsApi.md +215 -0
- data/docs/ComponentChange.md +20 -0
- data/docs/ComponentCost.md +9 -0
- data/docs/CompoundUsage.md +11 -0
- data/docs/CompoundUsageSession.md +11 -0
- data/docs/ConfigurationsApi.md +221 -0
- data/docs/Coupon.md +32 -0
- data/docs/CouponBook.md +21 -0
- data/docs/CouponBookDefinition.md +24 -0
- data/docs/CouponBookDefinitionPagedMetadata.md +14 -0
- data/docs/CouponBookPagedMetadata.md +14 -0
- data/docs/CouponDefinition.md +26 -0
- data/docs/CouponDefinitionPagedMetadata.md +14 -0
- data/docs/CouponDiscount.md +18 -0
- data/docs/CouponDiscountEstimate.md +13 -0
- data/docs/CouponInstance.md +26 -0
- data/docs/CouponInstanceExistingValue.md +15 -0
- data/docs/CouponInstancePagedMetadata.md +14 -0
- data/docs/CouponModifierBase.md +22 -0
- data/docs/CouponModifierBasePagedMetadata.md +14 -0
- data/docs/CouponPagedMetadata.md +14 -0
- data/docs/CouponRule.md +24 -0
- data/docs/CouponRulePagedMetadata.md +14 -0
- data/docs/CouponUniqueCodesRequest.md +11 -0
- data/docs/CouponUniqueCodesResponse.md +10 -0
- data/docs/CouponUniqueCodesResponsePagedMetadata.md +14 -0
- data/docs/CouponWrapperResponse.md +13 -0
- data/docs/CouponbookApi.md +496 -0
- data/docs/CouponbookdefinitionApi.md +329 -0
- data/docs/CoupondefinitionApi.md +267 -0
- data/docs/CouponinstanceApi.md +578 -0
- data/docs/CouponmodifierApi.md +369 -0
- data/docs/CouponruleApi.md +269 -0
- data/docs/CouponsApi.md +456 -0
- data/docs/CreateAccountProfileRequest.md +20 -0
- data/docs/CreateAccountRequest.md +13 -0
- data/docs/CreateAddressRequest.md +17 -0
- data/docs/CreateAggregatingComponentRequest.md +10 -0
- data/docs/CreateAggregatingSubscriptionRequest.md +21 -0
- data/docs/CreateProfileAddressRequest.md +16 -0
- data/docs/CreateSubscriptionBatchRequest.md +10 -0
- data/docs/CreateSubscriptionChargeAmendment.md +29 -0
- data/docs/CreateSubscriptionRequest.md +26 -0
- data/docs/CreditAccountRequest.md +13 -0
- data/docs/CreditNote.md +21 -0
- data/docs/CreditNotePagedMetadata.md +14 -0
- data/docs/CreditSubscriptionRequest.md +12 -0
- data/docs/CreditnotesApi.md +339 -0
- data/docs/CybersourceTokenPagedMetadata.md +14 -0
- data/docs/CybersourcetokensApi.md +259 -0
- data/docs/DataSynchronisationAppConfigurationPagedMetadata.md +14 -0
- data/docs/DataSynchronisationConfiguration.md +20 -0
- data/docs/DataSynchronisationConfigurationPagedMetadata.md +14 -0
- data/docs/DataSynchronizationJobPagedMetadata.md +14 -0
- data/docs/DebtsResultPagedMetadata.md +14 -0
- data/docs/DunningLine.md +18 -0
- data/docs/DunningLinePagedMetadata.md +14 -0
- data/docs/DunninglinesApi.md +328 -0
- data/docs/DynamicMetadata.md +7 -0
- data/docs/Email.md +35 -0
- data/docs/EmailPagedMetadata.md +14 -0
- data/docs/EmailProvider.md +18 -0
- data/docs/EmailProviderPagedMetadata.md +14 -0
- data/docs/EmailSubscription.md +20 -0
- data/docs/EmailSubscriptionPagedMetadata.md +14 -0
- data/docs/EmailprovidersApi.md +221 -0
- data/docs/EmailsApi.md +164 -0
- data/docs/EmailsubscriptionsApi.md +273 -0
- data/docs/EndTrialAmendment.md +19 -0
- data/docs/Event.md +15 -0
- data/docs/EventData.md +9 -0
- data/docs/FileSham.md +7 -0
- data/docs/FixedTerm.md +24 -0
- data/docs/FixedTermDefinitionPagedMetadata.md +14 -0
- data/docs/FixedTermExpiryAmendment.md +20 -0
- data/docs/FixedTermPagedMetadata.md +14 -0
- data/docs/FixedtermdefinitionsApi.md +104 -0
- data/docs/FixedtermsApi.md +56 -0
- data/docs/FlatPricingComponent.md +32 -0
- data/docs/ImportInvoiceLine.md +16 -0
- data/docs/InsertableBillingEntity.md +21 -0
- data/docs/Invoice.md +54 -0
- data/docs/InvoiceChargeRequest.md +11 -0
- data/docs/InvoiceLine.md +38 -0
- data/docs/InvoiceLinePayment.md +36 -0
- data/docs/InvoiceLinePaymentPagedMetadata.md +14 -0
- data/docs/InvoiceNextExecutionAttemptAmendment.md +21 -0
- data/docs/InvoiceOutstandingChargesAmendment.md +20 -0
- data/docs/InvoicePagedMetadata.md +14 -0
- data/docs/InvoicePayment.md +22 -0
- data/docs/InvoiceRecalculationAmendment.md +23 -0
- data/docs/InvoiceRecalculationRequest.md +12 -0
- data/docs/InvoicesApi.md +2474 -0
- data/docs/IssueInvoiceAmendment.md +20 -0
- data/docs/MetadataApi.md +210 -0
- data/docs/MetadataKeyValuesPagedMetadata.md +14 -0
- data/docs/MigrationRequest.md +16 -0
- data/docs/ModelAlias.md +14 -0
- data/docs/MutableBillingEntity.md +27 -0
- data/docs/Notification.md +27 -0
- data/docs/NotificationPagedMetadata.md +14 -0
- data/docs/NotificationsApi.md +370 -0
- data/docs/Organization.md +21 -0
- data/docs/OrganizationPagedMetadata.md +14 -0
- data/docs/OrganizationsApi.md +378 -0
- data/docs/Password.md +14 -0
- data/docs/PasswordPagedMetadata.md +14 -0
- data/docs/PasswordResetRequest.md +8 -0
- data/docs/PasswordsApi.md +56 -0
- data/docs/PauseRequest.md +9 -0
- data/docs/Payment.md +24 -0
- data/docs/PaymentMethod.md +32 -0
- data/docs/PaymentMethodPagedMetadata.md +14 -0
- data/docs/PaymentMethodSubscriptionLink.md +17 -0
- data/docs/PaymentMethodSubscriptionLinkPagedMetadata.md +14 -0
- data/docs/PaymentPagedMetadata.md +14 -0
- data/docs/PaymentRetryRequest.md +9 -0
- data/docs/PaymentmethodsApi.md +445 -0
- data/docs/PaymentmethodsubscriptionlinksApi.md +107 -0
- data/docs/PaymentsApi.md +464 -0
- data/docs/PendingComponentValueChange.md +11 -0
- data/docs/Period.md +16 -0
- data/docs/PeriodPagedMetadata.md +14 -0
- data/docs/PeriodsApi.md +125 -0
- data/docs/PermissionActionEntityPagedMetadata.md +14 -0
- data/docs/PermissionResourceEntityPagedMetadata.md +14 -0
- data/docs/PermissionsApi.md +322 -0
- data/docs/PriceCalculationPagedMetadata.md +14 -0
- data/docs/PricingComponent.md +32 -0
- data/docs/PricingComponentCouponModifier.md +22 -0
- data/docs/PricingComponentMigrationValue.md +12 -0
- data/docs/PricingComponentPagedMetadata.md +14 -0
- data/docs/PricingComponentQuantityRequest.md +10 -0
- data/docs/PricingComponentTier.md +19 -0
- data/docs/PricingComponentTierPagedMetadata.md +14 -0
- data/docs/PricingComponentValue.md +20 -0
- data/docs/PricingComponentValueChangeAmendment.md +22 -0
- data/docs/PricingComponentValueChangePagedMetadata.md +14 -0
- data/docs/PricingComponentValueMigrationAmendmentMapping.md +16 -0
- data/docs/PricingComponentValuePagedMetadata.md +14 -0
- data/docs/PricingComponentValueRequest.md +12 -0
- data/docs/PricingComponentValueResponsePagedMetadata.md +14 -0
- data/docs/PricingcalculatorApi.md +152 -0
- data/docs/PricingcomponentsApi.md +339 -0
- data/docs/PricingcomponenttiersApi.md +281 -0
- data/docs/PricingcomponentvaluechangesApi.md +345 -0
- data/docs/PricingcomponentvaluesApi.md +287 -0
- data/docs/Product.md +25 -0
- data/docs/ProductCouponModifier.md +22 -0
- data/docs/ProductPagedMetadata.md +14 -0
- data/docs/ProductPaymentsResultPagedMetadata.md +14 -0
- data/docs/ProductRatePlan.md +39 -0
- data/docs/ProductRatePlanMigrationAmendment.md +27 -0
- data/docs/ProductRatePlanPagedMetadata.md +14 -0
- data/docs/ProductRatePlanPaymentsResultPagedMetadata.md +14 -0
- data/docs/ProductrateplansApi.md +786 -0
- data/docs/ProductsApi.md +493 -0
- data/docs/Profile.md +25 -0
- data/docs/ProfilePagedMetadata.md +14 -0
- data/docs/ProfilesApi.md +287 -0
- data/docs/QuoteRequest.md +24 -0
- data/docs/QuoteRequestValue.md +11 -0
- data/docs/QuotesApi.md +56 -0
- data/docs/RecalculateChargeRequest.md +15 -0
- data/docs/Receipt.md +36 -0
- data/docs/ReceiptPagedMetadata.md +14 -0
- data/docs/ReceiptsApi.md +421 -0
- data/docs/Refund.md +35 -0
- data/docs/RefundPagedMetadata.md +14 -0
- data/docs/RefundsApi.md +432 -0
- data/docs/ResumeRequest.md +10 -0
- data/docs/ResumeSubscriptionAmendment.md +19 -0
- data/docs/RevenueAttribution.md +31 -0
- data/docs/RevenueAttributionPagedMetadata.md +14 -0
- data/docs/ReviveSubscriptionRequest.md +8 -0
- data/docs/Role.md +19 -0
- data/docs/RolePagedMetadata.md +14 -0
- data/docs/RolesApi.md +327 -0
- data/docs/RuleSatisfaction.md +11 -0
- data/docs/SearchApi.md +70 -0
- data/docs/SearchResultPagedMetadata.md +14 -0
- data/docs/ServiceEndAmendment.md +19 -0
- data/docs/StripeACHTokenPagedMetadata.md +14 -0
- data/docs/StripeAuthCaptureRequest.md +20 -0
- data/docs/StripeObject.md +7 -0
- data/docs/StripeTokenPagedMetadata.md +14 -0
- data/docs/Subscription.md +47 -0
- data/docs/SubscriptionCancellationPagedMetadata.md +14 -0
- data/docs/SubscriptionCharge.md +32 -0
- data/docs/SubscriptionChargePagedMetadata.md +14 -0
- data/docs/SubscriptionLTVResultPagedMetadata.md +14 -0
- data/docs/SubscriptionPagedMetadata.md +14 -0
- data/docs/SubscriptionsApi.md +2841 -0
- data/docs/SwaggerTypeList.md +9 -0
- data/docs/SwaggerTypeListInv.md +8 -0
- data/docs/SwaggerTypeListSubs.md +9 -0
- data/docs/SynchAppConfigsApi.md +208 -0
- data/docs/SynchConfigsApi.md +317 -0
- data/docs/SynchJobsApi.md +421 -0
- data/docs/TaxationLinkPagedMetadata.md +14 -0
- data/docs/TaxationStrategyPagedMetadata.md +14 -0
- data/docs/TaxationlinksApi.md +339 -0
- data/docs/TaxationstrategiesApi.md +514 -0
- data/docs/TieredPricingComponent.md +32 -0
- data/docs/TieredVolumePricingComponent.md +32 -0
- data/docs/TimeApi.md +56 -0
- data/docs/TimeRequest.md +16 -0
- data/docs/TimeResponse.md +18 -0
- data/docs/TimeResponsePagedMetadata.md +14 -0
- data/docs/TimeZone.md +11 -0
- data/docs/TimerAmendment.md +26 -0
- data/docs/TokenizationApi.md +340 -0
- data/docs/TokenizationPreAuthPagedMetadata.md +14 -0
- data/docs/TrustCommerceTokenPagedMetadata.md +14 -0
- data/docs/UnitDiscount.md +11 -0
- data/docs/UnitOfMeasure.md +16 -0
- data/docs/UnitOfMeasureCouponModifier.md +22 -0
- data/docs/UnitOfMeasurePagedMetadata.md +14 -0
- data/docs/UnitofmeasureApi.md +215 -0
- data/docs/UpdateAddressRequest.md +18 -0
- data/docs/UpdateComponentValueAmendment.md +23 -0
- data/docs/UpdateProfileRequest.md +22 -0
- data/docs/UpdateRoleRequest.md +13 -0
- data/docs/UpdateSubscriptionRequest.md +16 -0
- data/docs/Usage.md +26 -0
- data/docs/UsageApi.md +296 -0
- data/docs/UsagePagedMetadata.md +14 -0
- data/docs/UsagePeriodPagedMetadata.md +14 -0
- data/docs/UsageRoundingStrategyPagedMetadata.md +14 -0
- data/docs/UsageSession.md +21 -0
- data/docs/UsageSessionPagedMetadata.md +14 -0
- data/docs/UsageperiodsApi.md +194 -0
- data/docs/UsageroundingstrategiesApi.md +228 -0
- data/docs/UsagesessionsApi.md +224 -0
- data/docs/User.md +21 -0
- data/docs/UserCreationRequest.md +17 -0
- data/docs/UserCreationResponsePagedMetadata.md +14 -0
- data/docs/UserPagedMetadata.md +14 -0
- data/docs/Username.md +13 -0
- data/docs/UsernamePagedMetadata.md +14 -0
- data/docs/UsernamesApi.md +56 -0
- data/docs/UsersApi.md +564 -0
- data/docs/VaultedgatewaysApi.md +648 -0
- data/docs/WebhookPagedMetadata.md +14 -0
- data/docs/WebhooksApi.md +366 -0
- data/git_push.sh +67 -0
- data/lib/bf_ruby2/api/accounts_api.rb +1257 -0
- data/lib/bf_ruby2/api/addresses_api.rb +148 -0
- data/lib/bf_ruby2/api/amendments_api.rb +819 -0
- data/lib/bf_ruby2/api/analytics_api.rb +815 -0
- data/lib/bf_ruby2/api/auditlogs_api.rb +410 -0
- data/lib/bf_ruby2/api/charges_api.rb +527 -0
- data/lib/bf_ruby2/api/clients_api.rb +282 -0
- data/lib/bf_ruby2/api/configurations_api.rb +298 -0
- data/lib/bf_ruby2/api/couponbook_api.rb +619 -0
- data/lib/bf_ruby2/api/couponbookdefinition_api.rb +420 -0
- data/lib/bf_ruby2/api/coupondefinition_api.rb +342 -0
- data/lib/bf_ruby2/api/couponinstance_api.rb +737 -0
- data/lib/bf_ruby2/api/couponmodifier_api.rb +456 -0
- data/lib/bf_ruby2/api/couponrule_api.rb +342 -0
- data/lib/bf_ruby2/api/coupons_api.rb +580 -0
- data/lib/bf_ruby2/api/creditnotes_api.rb +438 -0
- data/lib/bf_ruby2/api/cybersourcetokens_api.rb +330 -0
- data/lib/bf_ruby2/api/dunninglines_api.rb +422 -0
- data/lib/bf_ruby2/api/emailproviders_api.rb +288 -0
- data/lib/bf_ruby2/api/emails_api.rb +214 -0
- data/lib/bf_ruby2/api/emailsubscriptions_api.rb +364 -0
- data/lib/bf_ruby2/api/fixedtermdefinitions_api.rb +148 -0
- data/lib/bf_ruby2/api/fixedterms_api.rb +91 -0
- data/lib/bf_ruby2/api/invoices_api.rb +3066 -0
- data/lib/bf_ruby2/api/metadata_api.rb +266 -0
- data/lib/bf_ruby2/api/notifications_api.rb +480 -0
- data/lib/bf_ruby2/api/organizations_api.rb +476 -0
- data/lib/bf_ruby2/api/passwords_api.rb +91 -0
- data/lib/bf_ruby2/api/paymentmethods_api.rb +565 -0
- data/lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb +153 -0
- data/lib/bf_ruby2/api/payments_api.rb +601 -0
- data/lib/bf_ruby2/api/periods_api.rb +180 -0
- data/lib/bf_ruby2/api/permissions_api.rb +408 -0
- data/lib/bf_ruby2/api/pricingcalculator_api.rb +205 -0
- data/lib/bf_ruby2/api/pricingcomponents_api.rb +438 -0
- data/lib/bf_ruby2/api/pricingcomponenttiers_api.rb +369 -0
- data/lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb +447 -0
- data/lib/bf_ruby2/api/pricingcomponentvalues_api.rb +378 -0
- data/lib/bf_ruby2/api/productrateplans_api.rb +971 -0
- data/lib/bf_ruby2/api/products_api.rb +611 -0
- data/lib/bf_ruby2/api/profiles_api.rb +375 -0
- data/lib/bf_ruby2/api/quotes_api.rb +91 -0
- data/lib/bf_ruby2/api/receipts_api.rb +559 -0
- data/lib/bf_ruby2/api/refunds_api.rb +540 -0
- data/lib/bf_ruby2/api/roles_api.rb +421 -0
- data/lib/bf_ruby2/api/search_api.rb +109 -0
- data/lib/bf_ruby2/api/subscriptions_api.rb +3490 -0
- data/lib/bf_ruby2/api/synch_app_configs_api.rb +272 -0
- data/lib/bf_ruby2/api/synch_configs_api.rb +403 -0
- data/lib/bf_ruby2/api/synch_jobs_api.rb +535 -0
- data/lib/bf_ruby2/api/taxationlinks_api.rb +438 -0
- data/lib/bf_ruby2/api/taxationstrategies_api.rb +660 -0
- data/lib/bf_ruby2/api/time_api.rb +91 -0
- data/lib/bf_ruby2/api/tokenization_api.rb +431 -0
- data/lib/bf_ruby2/api/unitofmeasure_api.rb +282 -0
- data/lib/bf_ruby2/api/usage_api.rb +389 -0
- data/lib/bf_ruby2/api/usageperiods_api.rb +267 -0
- data/lib/bf_ruby2/api/usageroundingstrategies_api.rb +304 -0
- data/lib/bf_ruby2/api/usagesessions_api.rb +298 -0
- data/lib/bf_ruby2/api/usernames_api.rb +91 -0
- data/lib/bf_ruby2/api/users_api.rb +692 -0
- data/lib/bf_ruby2/api/vaultedgateways_api.rb +787 -0
- data/lib/bf_ruby2/api/webhooks_api.rb +461 -0
- data/lib/bf_ruby2/api_client.rb +378 -0
- data/lib/bf_ruby2/api_error.rb +47 -0
- data/lib/bf_ruby2/configuration.rb +207 -0
- data/lib/bf_ruby2/models/account.rb +335 -0
- data/lib/bf_ruby2/models/account_ltv_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/account_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/account_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/add_charge_request.rb +414 -0
- data/lib/bf_ruby2/models/add_coupon_code_request.rb +231 -0
- data/lib/bf_ruby2/models/add_payment_method_request.rb +200 -0
- data/lib/bf_ruby2/models/add_taxation_strategy_request.rb +230 -0
- data/lib/bf_ruby2/models/address.rb +359 -0
- data/lib/bf_ruby2/models/address_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/aggregating_component.rb +294 -0
- data/lib/bf_ruby2/models/amendment.rb +374 -0
- data/lib/bf_ruby2/models/amendment_discard_amendment.rb +385 -0
- data/lib/bf_ruby2/models/amendment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/amendment_price_n_time_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_quote.rb +525 -0
- data/lib/bf_ruby2/models/api_quote_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_quote_response_quantity.rb +405 -0
- data/lib/bf_ruby2/models/audit_entry.rb +359 -0
- data/lib/bf_ruby2/models/audit_entry_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/auth_capture_request.rb +337 -0
- data/lib/bf_ruby2/models/authorize_net_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/bank_account_verification_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/bf_error.rb +265 -0
- data/lib/bf_ruby2/models/bf_permission.rb +337 -0
- data/lib/bf_ruby2/models/bf_permission_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/billforward_managed_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/billing_entity_base.rb +200 -0
- data/lib/bf_ruby2/models/braintree_auth_capture_request.rb +358 -0
- data/lib/bf_ruby2/models/braintree_capture_request.rb +327 -0
- data/lib/bf_ruby2/models/braintree_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cancel_subscription_request.rb +301 -0
- data/lib/bf_ruby2/models/cancellation_amendment.rb +451 -0
- data/lib/bf_ruby2/models/cass_churn_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cass_payment_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cass_upgrade_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/client.rb +342 -0
- data/lib/bf_ruby2/models/client_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/component_change.rb +373 -0
- data/lib/bf_ruby2/models/component_cost.rb +208 -0
- data/lib/bf_ruby2/models/compound_usage.rb +234 -0
- data/lib/bf_ruby2/models/compound_usage_session.rb +233 -0
- data/lib/bf_ruby2/models/coupon.rb +484 -0
- data/lib/bf_ruby2/models/coupon_book.rb +342 -0
- data/lib/bf_ruby2/models/coupon_book_definition.rb +417 -0
- data/lib/bf_ruby2/models/coupon_book_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_book_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_definition.rb +454 -0
- data/lib/bf_ruby2/models/coupon_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_discount.rb +298 -0
- data/lib/bf_ruby2/models/coupon_discount_estimate.rb +258 -0
- data/lib/bf_ruby2/models/coupon_instance.rb +426 -0
- data/lib/bf_ruby2/models/coupon_instance_existing_value.rb +272 -0
- data/lib/bf_ruby2/models/coupon_instance_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_modifier_base.rb +410 -0
- data/lib/bf_ruby2/models/coupon_modifier_base_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_rule.rb +470 -0
- data/lib/bf_ruby2/models/coupon_rule_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_request.rb +232 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_response.rb +219 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_wrapper_response.rb +250 -0
- data/lib/bf_ruby2/models/create_account_profile_request.rb +323 -0
- data/lib/bf_ruby2/models/create_account_request.rb +248 -0
- data/lib/bf_ruby2/models/create_address_request.rb +298 -0
- data/lib/bf_ruby2/models/create_aggregating_component_request.rb +221 -0
- data/lib/bf_ruby2/models/create_aggregating_subscription_request.rb +393 -0
- data/lib/bf_ruby2/models/create_profile_address_request.rb +287 -0
- data/lib/bf_ruby2/models/create_subscription_batch_request.rb +222 -0
- data/lib/bf_ruby2/models/create_subscription_charge_amendment.rb +514 -0
- data/lib/bf_ruby2/models/create_subscription_request.rb +444 -0
- data/lib/bf_ruby2/models/credit_account_request.rb +252 -0
- data/lib/bf_ruby2/models/credit_note.rb +368 -0
- data/lib/bf_ruby2/models/credit_note_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/credit_subscription_request.rb +241 -0
- data/lib/bf_ruby2/models/cybersource_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronisation_app_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronisation_configuration.rb +362 -0
- data/lib/bf_ruby2/models/data_synchronisation_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronization_job_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/debts_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/dunning_line.rb +354 -0
- data/lib/bf_ruby2/models/dunning_line_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/dynamic_metadata.rb +190 -0
- data/lib/bf_ruby2/models/email.rb +518 -0
- data/lib/bf_ruby2/models/email_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/email_provider.rb +302 -0
- data/lib/bf_ruby2/models/email_provider_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/email_subscription.rb +364 -0
- data/lib/bf_ruby2/models/email_subscription_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/end_trial_amendment.rb +374 -0
- data/lib/bf_ruby2/models/event.rb +272 -0
- data/lib/bf_ruby2/models/event_data.rb +212 -0
- data/lib/bf_ruby2/models/file_sham.rb +190 -0
- data/lib/bf_ruby2/models/fixed_term.rb +419 -0
- data/lib/bf_ruby2/models/fixed_term_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/fixed_term_expiry_amendment.rb +385 -0
- data/lib/bf_ruby2/models/fixed_term_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/flat_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/import_invoice_line.rb +271 -0
- data/lib/bf_ruby2/models/insertable_billing_entity.rb +384 -0
- data/lib/bf_ruby2/models/invoice.rb +746 -0
- data/lib/bf_ruby2/models/invoice_charge_request.rb +267 -0
- data/lib/bf_ruby2/models/invoice_line.rb +575 -0
- data/lib/bf_ruby2/models/invoice_line_payment.rb +539 -0
- data/lib/bf_ruby2/models/invoice_line_payment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/invoice_next_execution_attempt_amendment.rb +398 -0
- data/lib/bf_ruby2/models/invoice_outstanding_charges_amendment.rb +385 -0
- data/lib/bf_ruby2/models/invoice_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/invoice_payment.rb +384 -0
- data/lib/bf_ruby2/models/invoice_recalculation_amendment.rb +444 -0
- data/lib/bf_ruby2/models/invoice_recalculation_request.rb +293 -0
- data/lib/bf_ruby2/models/issue_invoice_amendment.rb +385 -0
- data/lib/bf_ruby2/models/metadata_key_values_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/migration_request.rb +332 -0
- data/lib/bf_ruby2/models/model_alias.rb +266 -0
- data/lib/bf_ruby2/models/mutable_billing_entity.rb +472 -0
- data/lib/bf_ruby2/models/notification.rb +472 -0
- data/lib/bf_ruby2/models/notification_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/organization.rb +349 -0
- data/lib/bf_ruby2/models/organization_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/password.rb +266 -0
- data/lib/bf_ruby2/models/password_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/password_reset_request.rb +201 -0
- data/lib/bf_ruby2/models/pause_request.rb +210 -0
- data/lib/bf_ruby2/models/payment.rb +417 -0
- data/lib/bf_ruby2/models/payment_method.rb +487 -0
- data/lib/bf_ruby2/models/payment_method_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_method_subscription_link.rb +291 -0
- data/lib/bf_ruby2/models/payment_method_subscription_link_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_retry_request.rb +210 -0
- data/lib/bf_ruby2/models/pending_component_value_change.rb +226 -0
- data/lib/bf_ruby2/models/period.rb +330 -0
- data/lib/bf_ruby2/models/period_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/permission_action_entity_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/permission_resource_entity_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/price_calculation_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/pricing_component_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/pricing_component_migration_value.rb +242 -0
- data/lib/bf_ruby2/models/pricing_component_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_quantity_request.rb +220 -0
- data/lib/bf_ruby2/models/pricing_component_tier.rb +346 -0
- data/lib/bf_ruby2/models/pricing_component_tier_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value.rb +323 -0
- data/lib/bf_ruby2/models/pricing_component_value_change_amendment.rb +419 -0
- data/lib/bf_ruby2/models/pricing_component_value_change_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value_migration_amendment_mapping.rb +283 -0
- data/lib/bf_ruby2/models/pricing_component_value_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value_request.rb +288 -0
- data/lib/bf_ruby2/models/pricing_component_value_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product.rb +435 -0
- data/lib/bf_ruby2/models/product_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/product_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_rate_plan.rb +658 -0
- data/lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb +483 -0
- data/lib/bf_ruby2/models/product_rate_plan_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_rate_plan_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/profile.rb +378 -0
- data/lib/bf_ruby2/models/profile_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/quote_request.rb +431 -0
- data/lib/bf_ruby2/models/quote_request_value.rb +232 -0
- data/lib/bf_ruby2/models/recalculate_charge_request.rb +318 -0
- data/lib/bf_ruby2/models/receipt.rb +535 -0
- data/lib/bf_ruby2/models/receipt_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/refund.rb +535 -0
- data/lib/bf_ruby2/models/refund_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/resume_request.rb +222 -0
- data/lib/bf_ruby2/models/resume_subscription_amendment.rb +374 -0
- data/lib/bf_ruby2/models/revenue_attribution.rb +451 -0
- data/lib/bf_ruby2/models/revenue_attribution_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/revive_subscription_request.rb +200 -0
- data/lib/bf_ruby2/models/role.rb +318 -0
- data/lib/bf_ruby2/models/role_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/rule_satisfaction.rb +234 -0
- data/lib/bf_ruby2/models/search_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/service_end_amendment.rb +374 -0
- data/lib/bf_ruby2/models/stripe_ach_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/stripe_auth_capture_request.rb +367 -0
- data/lib/bf_ruby2/models/stripe_object.rb +190 -0
- data/lib/bf_ruby2/models/stripe_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription.rb +681 -0
- data/lib/bf_ruby2/models/subscription_cancellation_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_charge.rb +529 -0
- data/lib/bf_ruby2/models/subscription_charge_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_ltv_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/swagger_type_list.rb +210 -0
- data/lib/bf_ruby2/models/swagger_type_list_inv.rb +201 -0
- data/lib/bf_ruby2/models/swagger_type_list_subs.rb +212 -0
- data/lib/bf_ruby2/models/taxation_link_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/taxation_strategy_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/tiered_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/tiered_volume_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/time_request.rb +323 -0
- data/lib/bf_ruby2/models/time_response.rb +345 -0
- data/lib/bf_ruby2/models/time_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/time_zone.rb +226 -0
- data/lib/bf_ruby2/models/timer_amendment.rb +485 -0
- data/lib/bf_ruby2/models/tokenization_pre_auth_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/trust_commerce_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/unit_discount.rb +226 -0
- data/lib/bf_ruby2/models/unit_of_measure.rb +286 -0
- data/lib/bf_ruby2/models/unit_of_measure_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/unit_of_measure_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/update_address_request.rb +303 -0
- data/lib/bf_ruby2/models/update_component_value_amendment.rb +418 -0
- data/lib/bf_ruby2/models/update_profile_request.rb +342 -0
- data/lib/bf_ruby2/models/update_role_request.rb +253 -0
- data/lib/bf_ruby2/models/update_subscription_request.rb +328 -0
- data/lib/bf_ruby2/models/usage.rb +423 -0
- data/lib/bf_ruby2/models/usage_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_period_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_rounding_strategy_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_session.rb +368 -0
- data/lib/bf_ruby2/models/usage_session_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/user.rb +352 -0
- data/lib/bf_ruby2/models/user_creation_request.rb +302 -0
- data/lib/bf_ruby2/models/user_creation_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/user_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/username.rb +253 -0
- data/lib/bf_ruby2/models/username_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/webhook_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/version.rb +26 -0
- data/lib/bf_ruby2.rb +340 -0
- data/setup.scratch.rb +33 -0
- data/spec/api/accounts_api_spec.rb +318 -0
- data/spec/api/addresses_api_spec.rb +70 -0
- data/spec/api/amendments_api_spec.rb +220 -0
- data/spec/api/analytics_api_spec.rb +220 -0
- data/spec/api/auditlogs_api_spec.rb +131 -0
- data/spec/api/charges_api_spec.rb +156 -0
- data/spec/api/clients_api_spec.rb +100 -0
- data/spec/api/configurations_api_spec.rb +103 -0
- data/spec/api/couponbook_api_spec.rb +175 -0
- data/spec/api/couponbookdefinition_api_spec.rb +131 -0
- data/spec/api/coupondefinition_api_spec.rb +113 -0
- data/spec/api/couponinstance_api_spec.rb +203 -0
- data/spec/api/couponmodifier_api_spec.rb +138 -0
- data/spec/api/couponrule_api_spec.rb +113 -0
- data/spec/api/coupons_api_spec.rb +168 -0
- data/spec/api/creditnotes_api_spec.rb +135 -0
- data/spec/api/cybersourcetokens_api_spec.rb +109 -0
- data/spec/api/dunninglines_api_spec.rb +131 -0
- data/spec/api/emailproviders_api_spec.rb +102 -0
- data/spec/api/emails_api_spec.rb +85 -0
- data/spec/api/emailsubscriptions_api_spec.rb +115 -0
- data/spec/api/fixedtermdefinitions_api_spec.rb +70 -0
- data/spec/api/fixedterms_api_spec.rb +58 -0
- data/spec/api/invoices_api_spec.rb +727 -0
- data/spec/api/metadata_api_spec.rb +96 -0
- data/spec/api/notifications_api_spec.rb +148 -0
- data/spec/api/organizations_api_spec.rb +143 -0
- data/spec/api/passwords_api_spec.rb +58 -0
- data/spec/api/paymentmethods_api_spec.rb +163 -0
- data/spec/api/paymentmethodsubscriptionlinks_api_spec.rb +71 -0
- data/spec/api/payments_api_spec.rb +172 -0
- data/spec/api/periods_api_spec.rb +79 -0
- data/spec/api/permissions_api_spec.rb +127 -0
- data/spec/api/pricingcalculator_api_spec.rb +82 -0
- data/spec/api/pricingcomponents_api_spec.rb +136 -0
- data/spec/api/pricingcomponenttiers_api_spec.rb +120 -0
- data/spec/api/pricingcomponentvaluechanges_api_spec.rb +138 -0
- data/spec/api/pricingcomponentvalues_api_spec.rb +123 -0
- data/spec/api/productrateplans_api_spec.rb +254 -0
- data/spec/api/products_api_spec.rb +173 -0
- data/spec/api/profiles_api_spec.rb +122 -0
- data/spec/api/quotes_api_spec.rb +58 -0
- data/spec/api/receipts_api_spec.rb +164 -0
- data/spec/api/refunds_api_spec.rb +156 -0
- data/spec/api/roles_api_spec.rb +129 -0
- data/spec/api/search_api_spec.rb +64 -0
- data/spec/api/subscriptions_api_spec.rb +809 -0
- data/spec/api/synch_app_configs_api_spec.rb +96 -0
- data/spec/api/synch_configs_api_spec.rb +125 -0
- data/spec/api/synch_jobs_api_spec.rb +151 -0
- data/spec/api/taxationlinks_api_spec.rb +136 -0
- data/spec/api/taxationstrategies_api_spec.rb +185 -0
- data/spec/api/time_api_spec.rb +58 -0
- data/spec/api/tokenization_api_spec.rb +138 -0
- data/spec/api/unitofmeasure_api_spec.rb +100 -0
- data/spec/api/usage_api_spec.rb +125 -0
- data/spec/api/usageperiods_api_spec.rb +99 -0
- data/spec/api/usageroundingstrategies_api_spec.rb +106 -0
- data/spec/api/usagesessions_api_spec.rb +104 -0
- data/spec/api/usernames_api_spec.rb +58 -0
- data/spec/api/users_api_spec.rb +187 -0
- data/spec/api/vaultedgateways_api_spec.rb +206 -0
- data/spec/api/webhooks_api_spec.rb +138 -0
- data/spec/api_client_spec.rb +237 -0
- data/spec/configuration_spec.rb +53 -0
- data/spec/models/account_ltv_result_paged_metadata_spec.rb +89 -0
- data/spec/models/account_paged_metadata_spec.rb +89 -0
- data/spec/models/account_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/account_spec.rb +131 -0
- data/spec/models/add_charge_request_spec.rb +155 -0
- data/spec/models/add_coupon_code_request_spec.rb +71 -0
- data/spec/models/add_payment_method_request_spec.rb +53 -0
- data/spec/models/add_taxation_strategy_request_spec.rb +71 -0
- data/spec/models/address_paged_metadata_spec.rb +89 -0
- data/spec/models/address_spec.rb +143 -0
- data/spec/models/aggregating_component_spec.rb +107 -0
- data/spec/models/amendment_discard_amendment_spec.rb +137 -0
- data/spec/models/amendment_paged_metadata_spec.rb +89 -0
- data/spec/models/amendment_price_n_time_paged_metadata_spec.rb +89 -0
- data/spec/models/amendment_spec.rb +131 -0
- data/spec/models/api_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/api_quote_paged_metadata_spec.rb +89 -0
- data/spec/models/api_quote_response_quantity_spec.rb +159 -0
- data/spec/models/api_quote_spec.rb +225 -0
- data/spec/models/audit_entry_paged_metadata_spec.rb +89 -0
- data/spec/models/audit_entry_spec.rb +119 -0
- data/spec/models/auth_capture_request_spec.rb +115 -0
- data/spec/models/authorize_net_token_paged_metadata_spec.rb +89 -0
- data/spec/models/bank_account_verification_paged_metadata_spec.rb +89 -0
- data/spec/models/bf_error_spec.rb +75 -0
- data/spec/models/bf_permission_paged_metadata_spec.rb +89 -0
- data/spec/models/bf_permission_spec.rb +115 -0
- data/spec/models/billforward_managed_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/billing_entity_base_spec.rb +53 -0
- data/spec/models/braintree_auth_capture_request_spec.rb +127 -0
- data/spec/models/braintree_capture_request_spec.rb +125 -0
- data/spec/models/braintree_token_paged_metadata_spec.rb +89 -0
- data/spec/models/cancel_subscription_request_spec.rb +97 -0
- data/spec/models/cancellation_amendment_spec.rb +169 -0
- data/spec/models/cass_churn_result_paged_metadata_spec.rb +89 -0
- data/spec/models/cass_payment_result_paged_metadata_spec.rb +89 -0
- data/spec/models/cass_upgrade_result_paged_metadata_spec.rb +89 -0
- data/spec/models/client_paged_metadata_spec.rb +89 -0
- data/spec/models/client_spec.rb +131 -0
- data/spec/models/component_change_spec.rb +133 -0
- data/spec/models/component_cost_spec.rb +59 -0
- data/spec/models/compound_usage_session_spec.rb +71 -0
- data/spec/models/compound_usage_spec.rb +71 -0
- data/spec/models/coupon_book_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_book_definition_spec.rb +157 -0
- data/spec/models/coupon_book_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_book_spec.rb +131 -0
- data/spec/models/coupon_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_definition_spec.rb +173 -0
- data/spec/models/coupon_discount_estimate_spec.rb +83 -0
- data/spec/models/coupon_discount_spec.rb +113 -0
- data/spec/models/coupon_instance_existing_value_spec.rb +95 -0
- data/spec/models/coupon_instance_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_instance_spec.rb +165 -0
- data/spec/models/coupon_modifier_base_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_modifier_base_spec.rb +149 -0
- data/spec/models/coupon_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_rule_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_rule_spec.rb +173 -0
- data/spec/models/coupon_spec.rb +201 -0
- data/spec/models/coupon_unique_codes_request_spec.rb +71 -0
- data/spec/models/coupon_unique_codes_response_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_unique_codes_response_spec.rb +65 -0
- data/spec/models/coupon_wrapper_response_spec.rb +83 -0
- data/spec/models/create_account_profile_request_spec.rb +125 -0
- data/spec/models/create_account_request_spec.rb +83 -0
- data/spec/models/create_address_request_spec.rb +107 -0
- data/spec/models/create_aggregating_component_request_spec.rb +65 -0
- data/spec/models/create_aggregating_subscription_request_spec.rb +143 -0
- data/spec/models/create_profile_address_request_spec.rb +101 -0
- data/spec/models/create_subscription_batch_request_spec.rb +65 -0
- data/spec/models/create_subscription_charge_amendment_spec.rb +203 -0
- data/spec/models/create_subscription_request_spec.rb +173 -0
- data/spec/models/credit_account_request_spec.rb +83 -0
- data/spec/models/credit_note_paged_metadata_spec.rb +89 -0
- data/spec/models/credit_note_spec.rb +135 -0
- data/spec/models/credit_subscription_request_spec.rb +77 -0
- data/spec/models/cybersource_token_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_app_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_configuration_spec.rb +129 -0
- data/spec/models/data_synchronization_job_paged_metadata_spec.rb +89 -0
- data/spec/models/debts_result_paged_metadata_spec.rb +89 -0
- data/spec/models/dunning_line_paged_metadata_spec.rb +89 -0
- data/spec/models/dunning_line_spec.rb +121 -0
- data/spec/models/dynamic_metadata_spec.rb +47 -0
- data/spec/models/email_paged_metadata_spec.rb +89 -0
- data/spec/models/email_provider_paged_metadata_spec.rb +89 -0
- data/spec/models/email_provider_spec.rb +113 -0
- data/spec/models/email_spec.rb +223 -0
- data/spec/models/email_subscription_paged_metadata_spec.rb +89 -0
- data/spec/models/email_subscription_spec.rb +133 -0
- data/spec/models/end_trial_amendment_spec.rb +131 -0
- data/spec/models/event_data_spec.rb +59 -0
- data/spec/models/event_spec.rb +95 -0
- data/spec/models/file_sham_spec.rb +47 -0
- data/spec/models/fixed_term_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/fixed_term_expiry_amendment_spec.rb +137 -0
- data/spec/models/fixed_term_paged_metadata_spec.rb +89 -0
- data/spec/models/fixed_term_spec.rb +157 -0
- data/spec/models/flat_pricing_component_spec.rb +221 -0
- data/spec/models/import_invoice_line_spec.rb +101 -0
- data/spec/models/insertable_billing_entity_spec.rb +139 -0
- data/spec/models/invoice_charge_request_spec.rb +75 -0
- data/spec/models/invoice_line_payment_paged_metadata_spec.rb +89 -0
- data/spec/models/invoice_line_payment_spec.rb +225 -0
- data/spec/models/invoice_line_spec.rb +245 -0
- data/spec/models/invoice_next_execution_attempt_amendment_spec.rb +143 -0
- data/spec/models/invoice_outstanding_charges_amendment_spec.rb +137 -0
- data/spec/models/invoice_paged_metadata_spec.rb +89 -0
- data/spec/models/invoice_payment_spec.rb +141 -0
- data/spec/models/invoice_recalculation_amendment_spec.rb +163 -0
- data/spec/models/invoice_recalculation_request_spec.rb +85 -0
- data/spec/models/invoice_spec.rb +341 -0
- data/spec/models/issue_invoice_amendment_spec.rb +137 -0
- data/spec/models/metadata_key_values_paged_metadata_spec.rb +89 -0
- data/spec/models/migration_request_spec.rb +109 -0
- data/spec/models/model_alias_spec.rb +89 -0
- data/spec/models/mutable_billing_entity_spec.rb +183 -0
- data/spec/models/notification_paged_metadata_spec.rb +89 -0
- data/spec/models/notification_spec.rb +183 -0
- data/spec/models/organization_paged_metadata_spec.rb +89 -0
- data/spec/models/organization_spec.rb +131 -0
- data/spec/models/password_paged_metadata_spec.rb +89 -0
- data/spec/models/password_reset_request_spec.rb +53 -0
- data/spec/models/password_spec.rb +89 -0
- data/spec/models/pause_request_spec.rb +59 -0
- data/spec/models/payment_method_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_method_spec.rb +205 -0
- data/spec/models/payment_method_subscription_link_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_method_subscription_link_spec.rb +107 -0
- data/spec/models/payment_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_retry_request_spec.rb +59 -0
- data/spec/models/payment_spec.rb +157 -0
- data/spec/models/pending_component_value_change_spec.rb +71 -0
- data/spec/models/period_paged_metadata_spec.rb +89 -0
- data/spec/models/period_spec.rb +109 -0
- data/spec/models/permission_action_entity_paged_metadata_spec.rb +89 -0
- data/spec/models/permission_resource_entity_paged_metadata_spec.rb +89 -0
- data/spec/models/price_calculation_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_coupon_modifier_spec.rb +149 -0
- data/spec/models/pricing_component_migration_value_spec.rb +77 -0
- data/spec/models/pricing_component_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_quantity_request_spec.rb +65 -0
- data/spec/models/pricing_component_spec.rb +221 -0
- data/spec/models/pricing_component_tier_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_tier_spec.rb +123 -0
- data/spec/models/pricing_component_value_change_amendment_spec.rb +153 -0
- data/spec/models/pricing_component_value_change_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_migration_amendment_mapping_spec.rb +101 -0
- data/spec/models/pricing_component_value_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_request_spec.rb +85 -0
- data/spec/models/pricing_component_value_response_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_spec.rb +125 -0
- data/spec/models/product_coupon_modifier_spec.rb +149 -0
- data/spec/models/product_paged_metadata_spec.rb +89 -0
- data/spec/models/product_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_migration_amendment_spec.rb +187 -0
- data/spec/models/product_rate_plan_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_spec.rb +275 -0
- data/spec/models/product_spec.rb +167 -0
- data/spec/models/profile_paged_metadata_spec.rb +89 -0
- data/spec/models/profile_spec.rb +155 -0
- data/spec/models/quote_request_spec.rb +161 -0
- data/spec/models/quote_request_value_spec.rb +71 -0
- data/spec/models/recalculate_charge_request_spec.rb +103 -0
- data/spec/models/receipt_paged_metadata_spec.rb +89 -0
- data/spec/models/receipt_spec.rb +237 -0
- data/spec/models/refund_paged_metadata_spec.rb +89 -0
- data/spec/models/refund_spec.rb +227 -0
- data/spec/models/resume_request_spec.rb +65 -0
- data/spec/models/resume_subscription_amendment_spec.rb +131 -0
- data/spec/models/revenue_attribution_paged_metadata_spec.rb +89 -0
- data/spec/models/revenue_attribution_spec.rb +191 -0
- data/spec/models/revive_subscription_request_spec.rb +53 -0
- data/spec/models/role_paged_metadata_spec.rb +89 -0
- data/spec/models/role_spec.rb +119 -0
- data/spec/models/rule_satisfaction_spec.rb +71 -0
- data/spec/models/search_result_paged_metadata_spec.rb +89 -0
- data/spec/models/service_end_amendment_spec.rb +131 -0
- data/spec/models/stripe_ach_token_paged_metadata_spec.rb +89 -0
- data/spec/models/stripe_auth_capture_request_spec.rb +133 -0
- data/spec/models/stripe_object_spec.rb +47 -0
- data/spec/models/stripe_token_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_cancellation_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_charge_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_charge_spec.rb +217 -0
- data/spec/models/subscription_ltv_result_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_spec.rb +303 -0
- data/spec/models/swagger_type_list_inv_spec.rb +53 -0
- data/spec/models/swagger_type_list_spec.rb +59 -0
- data/spec/models/swagger_type_list_subs_spec.rb +59 -0
- data/spec/models/taxation_link_paged_metadata_spec.rb +89 -0
- data/spec/models/taxation_strategy_paged_metadata_spec.rb +89 -0
- data/spec/models/tiered_pricing_component_spec.rb +221 -0
- data/spec/models/tiered_volume_pricing_component_spec.rb +221 -0
- data/spec/models/time_request_spec.rb +105 -0
- data/spec/models/time_response_paged_metadata_spec.rb +89 -0
- data/spec/models/time_response_spec.rb +117 -0
- data/spec/models/time_zone_spec.rb +71 -0
- data/spec/models/timer_amendment_spec.rb +189 -0
- data/spec/models/tokenization_pre_auth_paged_metadata_spec.rb +89 -0
- data/spec/models/trust_commerce_token_paged_metadata_spec.rb +89 -0
- data/spec/models/unit_discount_spec.rb +71 -0
- data/spec/models/unit_of_measure_coupon_modifier_spec.rb +149 -0
- data/spec/models/unit_of_measure_paged_metadata_spec.rb +89 -0
- data/spec/models/unit_of_measure_spec.rb +101 -0
- data/spec/models/update_address_request_spec.rb +113 -0
- data/spec/models/update_component_value_amendment_spec.rb +155 -0
- data/spec/models/update_profile_request_spec.rb +137 -0
- data/spec/models/update_role_request_spec.rb +83 -0
- data/spec/models/update_subscription_request_spec.rb +109 -0
- data/spec/models/usage_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_period_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_rounding_strategy_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_session_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_session_spec.rb +135 -0
- data/spec/models/usage_spec.rb +165 -0
- data/spec/models/user_creation_request_spec.rb +107 -0
- data/spec/models/user_creation_response_paged_metadata_spec.rb +89 -0
- data/spec/models/user_paged_metadata_spec.rb +89 -0
- data/spec/models/user_spec.rb +131 -0
- data/spec/models/username_paged_metadata_spec.rb +89 -0
- data/spec/models/username_spec.rb +83 -0
- data/spec/models/webhook_paged_metadata_spec.rb +89 -0
- data/spec/spec_helper.rb +122 -0
- metadata +1401 -0
data/docs/AccountsApi.md
ADDED
|
@@ -0,0 +1,1021 @@
|
|
|
1
|
+
# BillForward::AccountsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080/RestAPI*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**add_credit_note_to_account**](AccountsApi.md#add_credit_note_to_account) | **POST** /accounts/{account-ID}/credit | Creates a credit-note which may be used by any subscription of this account.
|
|
8
|
+
[**add_permission_to_account**](AccountsApi.md#add_permission_to_account) | **POST** /accounts/{account-ID}/roles/{role} | Add a role to the account
|
|
9
|
+
[**create_account**](AccountsApi.md#create_account) | **POST** /accounts | Create an Account.
|
|
10
|
+
[**delete_account**](AccountsApi.md#delete_account) | **DELETE** /accounts/{account-ID} | Delete the account specified by the account-ID parameter.
|
|
11
|
+
[**delete_metadata_for_account**](AccountsApi.md#delete_metadata_for_account) | **DELETE** /accounts/{account-ID}/metadata | Remove any associated metadata.
|
|
12
|
+
[**get_account_by_id**](AccountsApi.md#get_account_by_id) | **GET** /accounts/{account-ID} | Returns a single account, specified by the account-ID parameter.
|
|
13
|
+
[**get_accounts_by_created**](AccountsApi.md#get_accounts_by_created) | **GET** /accounts/created/{lower-threshold}/{upper-threshold} | Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
14
|
+
[**get_accounts_by_updated**](AccountsApi.md#get_accounts_by_updated) | **GET** /accounts/updated/{lower-threshold}/{upper-threshold} | Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
15
|
+
[**get_accounts_by_user_id**](AccountsApi.md#get_accounts_by_user_id) | **GET** /accounts/user/{user-ID} | Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
16
|
+
[**get_all_accounts**](AccountsApi.md#get_all_accounts) | **GET** /accounts | Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order.
|
|
17
|
+
[**get_available_credit_on_account**](AccountsApi.md#get_available_credit_on_account) | **GET** /accounts/{account-ID}/credit | Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order.
|
|
18
|
+
[**get_metadata_for_account**](AccountsApi.md#get_metadata_for_account) | **GET** /accounts/{account-ID}/metadata | Retrieve any associated metadata.
|
|
19
|
+
[**get_permissions_on_account**](AccountsApi.md#get_permissions_on_account) | **GET** /accounts/{account-ID}/roles | Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
20
|
+
[**remove_credit_from_account**](AccountsApi.md#remove_credit_from_account) | **DELETE** /accounts/{account-ID}/credit/{value} | Decrease the amount of credit by the value specified or entirely if no value provided.
|
|
21
|
+
[**remove_permission_from_account**](AccountsApi.md#remove_permission_from_account) | **DELETE** /accounts/{account-ID}/roles/{role} | Revoke the specified role.
|
|
22
|
+
[**set_metadata_for_account**](AccountsApi.md#set_metadata_for_account) | **POST** /accounts/{account-ID}/metadata | Remove any existing metadata keys and create the provided data.
|
|
23
|
+
[**update_account**](AccountsApi.md#update_account) | **PUT** /accounts | Update an Account.
|
|
24
|
+
[**upsert_metadata_for_account**](AccountsApi.md#upsert_metadata_for_account) | **PUT** /accounts/{account-ID}/metadata | Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
# **add_credit_note_to_account**
|
|
28
|
+
> CreditNotePagedMetadata add_credit_note_to_account(account_id, credit_note)
|
|
29
|
+
|
|
30
|
+
Creates a credit-note which may be used by any subscription of this account.
|
|
31
|
+
|
|
32
|
+
{\"nickname\":\"Add Credit\",\"request\":\"addCreditNoteToAccountRequest.html\", \"response\":\"addCreditNoteToAccount.html\"}
|
|
33
|
+
|
|
34
|
+
### Example
|
|
35
|
+
```ruby
|
|
36
|
+
# load the gem
|
|
37
|
+
require 'bf_ruby2'
|
|
38
|
+
|
|
39
|
+
api_instance = BillForward::AccountsApi.new
|
|
40
|
+
|
|
41
|
+
account_id = "account_id_example" # String | ID of the account.
|
|
42
|
+
|
|
43
|
+
credit_note = BillForward::CreditAccountRequest.new # CreditAccountRequest | The credit-note request
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
begin
|
|
47
|
+
#Creates a credit-note which may be used by any subscription of this account.
|
|
48
|
+
result = api_instance.add_credit_note_to_account(account_id, credit_note)
|
|
49
|
+
p result
|
|
50
|
+
rescue BillForward::ApiError => e
|
|
51
|
+
puts "Exception when calling AccountsApi->add_credit_note_to_account: #{e}"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Parameters
|
|
56
|
+
|
|
57
|
+
Name | Type | Description | Notes
|
|
58
|
+
------------- | ------------- | ------------- | -------------
|
|
59
|
+
**account_id** | **String**| ID of the account. |
|
|
60
|
+
**credit_note** | [**CreditAccountRequest**](CreditAccountRequest.md)| The credit-note request |
|
|
61
|
+
|
|
62
|
+
### Return type
|
|
63
|
+
|
|
64
|
+
[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md)
|
|
65
|
+
|
|
66
|
+
### Authorization
|
|
67
|
+
|
|
68
|
+
No authorization required
|
|
69
|
+
|
|
70
|
+
### HTTP request headers
|
|
71
|
+
|
|
72
|
+
- **Content-Type**: application/json
|
|
73
|
+
- **Accept**: application/json
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
# **add_permission_to_account**
|
|
78
|
+
> RolePagedMetadata add_permission_to_account(account_id, role, opts)
|
|
79
|
+
|
|
80
|
+
Add a role to the account
|
|
81
|
+
|
|
82
|
+
{\"nickname\":\"Add Role\",\"response\":\"addRoleToAccountResponse.html\",\"request\":\"addRoleToAccountRequest.html\"}
|
|
83
|
+
|
|
84
|
+
### Example
|
|
85
|
+
```ruby
|
|
86
|
+
# load the gem
|
|
87
|
+
require 'bf_ruby2'
|
|
88
|
+
|
|
89
|
+
api_instance = BillForward::AccountsApi.new
|
|
90
|
+
|
|
91
|
+
account_id = "account_id_example" # String | ID of the account.
|
|
92
|
+
|
|
93
|
+
role = "role_example" # String | ID or name of the role.
|
|
94
|
+
|
|
95
|
+
opts = {
|
|
96
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
begin
|
|
100
|
+
#Add a role to the account
|
|
101
|
+
result = api_instance.add_permission_to_account(account_id, role, opts)
|
|
102
|
+
p result
|
|
103
|
+
rescue BillForward::ApiError => e
|
|
104
|
+
puts "Exception when calling AccountsApi->add_permission_to_account: #{e}"
|
|
105
|
+
end
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Parameters
|
|
109
|
+
|
|
110
|
+
Name | Type | Description | Notes
|
|
111
|
+
------------- | ------------- | ------------- | -------------
|
|
112
|
+
**account_id** | **String**| ID of the account. |
|
|
113
|
+
**role** | **String**| ID or name of the role. |
|
|
114
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
115
|
+
|
|
116
|
+
### Return type
|
|
117
|
+
|
|
118
|
+
[**RolePagedMetadata**](RolePagedMetadata.md)
|
|
119
|
+
|
|
120
|
+
### Authorization
|
|
121
|
+
|
|
122
|
+
No authorization required
|
|
123
|
+
|
|
124
|
+
### HTTP request headers
|
|
125
|
+
|
|
126
|
+
- **Content-Type**: application/json
|
|
127
|
+
- **Accept**: application/json
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
# **create_account**
|
|
132
|
+
> AccountPagedMetadata create_account(request)
|
|
133
|
+
|
|
134
|
+
Create an Account.
|
|
135
|
+
|
|
136
|
+
{\"nickname\":\"Create a new account\",\"response\":\"createAccountResponse.html\",\"request\":\"createAccountRequest.html\"}
|
|
137
|
+
|
|
138
|
+
### Example
|
|
139
|
+
```ruby
|
|
140
|
+
# load the gem
|
|
141
|
+
require 'bf_ruby2'
|
|
142
|
+
|
|
143
|
+
api_instance = BillForward::AccountsApi.new
|
|
144
|
+
|
|
145
|
+
request = BillForward::CreateAccountRequest.new # CreateAccountRequest | The account object to be created.
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
begin
|
|
149
|
+
#Create an Account.
|
|
150
|
+
result = api_instance.create_account(request)
|
|
151
|
+
p result
|
|
152
|
+
rescue BillForward::ApiError => e
|
|
153
|
+
puts "Exception when calling AccountsApi->create_account: #{e}"
|
|
154
|
+
end
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Parameters
|
|
158
|
+
|
|
159
|
+
Name | Type | Description | Notes
|
|
160
|
+
------------- | ------------- | ------------- | -------------
|
|
161
|
+
**request** | [**CreateAccountRequest**](CreateAccountRequest.md)| The account object to be created. |
|
|
162
|
+
|
|
163
|
+
### Return type
|
|
164
|
+
|
|
165
|
+
[**AccountPagedMetadata**](AccountPagedMetadata.md)
|
|
166
|
+
|
|
167
|
+
### Authorization
|
|
168
|
+
|
|
169
|
+
No authorization required
|
|
170
|
+
|
|
171
|
+
### HTTP request headers
|
|
172
|
+
|
|
173
|
+
- **Content-Type**: application/json
|
|
174
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
# **delete_account**
|
|
179
|
+
> AccountPagedMetadata delete_account(account_id, delete_gateway_data, organizations)
|
|
180
|
+
|
|
181
|
+
Delete the account specified by the account-ID parameter.
|
|
182
|
+
|
|
183
|
+
{\"nickname\":\"Retire\",\"response\":\"deleteAccount.html\"}
|
|
184
|
+
|
|
185
|
+
### Example
|
|
186
|
+
```ruby
|
|
187
|
+
# load the gem
|
|
188
|
+
require 'bf_ruby2'
|
|
189
|
+
|
|
190
|
+
api_instance = BillForward::AccountsApi.new
|
|
191
|
+
|
|
192
|
+
account_id = "account_id_example" # String |
|
|
193
|
+
|
|
194
|
+
delete_gateway_data = true # BOOLEAN |
|
|
195
|
+
|
|
196
|
+
organizations = ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
begin
|
|
200
|
+
#Delete the account specified by the account-ID parameter.
|
|
201
|
+
result = api_instance.delete_account(account_id, delete_gateway_data, organizations)
|
|
202
|
+
p result
|
|
203
|
+
rescue BillForward::ApiError => e
|
|
204
|
+
puts "Exception when calling AccountsApi->delete_account: #{e}"
|
|
205
|
+
end
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Parameters
|
|
209
|
+
|
|
210
|
+
Name | Type | Description | Notes
|
|
211
|
+
------------- | ------------- | ------------- | -------------
|
|
212
|
+
**account_id** | **String**| |
|
|
213
|
+
**delete_gateway_data** | **BOOLEAN**| |
|
|
214
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. |
|
|
215
|
+
|
|
216
|
+
### Return type
|
|
217
|
+
|
|
218
|
+
[**AccountPagedMetadata**](AccountPagedMetadata.md)
|
|
219
|
+
|
|
220
|
+
### Authorization
|
|
221
|
+
|
|
222
|
+
No authorization required
|
|
223
|
+
|
|
224
|
+
### HTTP request headers
|
|
225
|
+
|
|
226
|
+
- **Content-Type**: text/plain, application/json
|
|
227
|
+
- **Accept**: application/json
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
# **delete_metadata_for_account**
|
|
232
|
+
> DynamicMetadata delete_metadata_for_account(account_id, opts)
|
|
233
|
+
|
|
234
|
+
Remove any associated metadata.
|
|
235
|
+
|
|
236
|
+
{\"nickname\":\"Clear metadata from account\",\"request\" :\"deleteAccountMetadataRequest.html\",\"response\":\"deleteAccountMetadataResponse.html\"}
|
|
237
|
+
|
|
238
|
+
### Example
|
|
239
|
+
```ruby
|
|
240
|
+
# load the gem
|
|
241
|
+
require 'bf_ruby2'
|
|
242
|
+
|
|
243
|
+
api_instance = BillForward::AccountsApi.new
|
|
244
|
+
|
|
245
|
+
account_id = "account_id_example" # String |
|
|
246
|
+
|
|
247
|
+
opts = {
|
|
248
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
begin
|
|
252
|
+
#Remove any associated metadata.
|
|
253
|
+
result = api_instance.delete_metadata_for_account(account_id, opts)
|
|
254
|
+
p result
|
|
255
|
+
rescue BillForward::ApiError => e
|
|
256
|
+
puts "Exception when calling AccountsApi->delete_metadata_for_account: #{e}"
|
|
257
|
+
end
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
### Parameters
|
|
261
|
+
|
|
262
|
+
Name | Type | Description | Notes
|
|
263
|
+
------------- | ------------- | ------------- | -------------
|
|
264
|
+
**account_id** | **String**| |
|
|
265
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
266
|
+
|
|
267
|
+
### Return type
|
|
268
|
+
|
|
269
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
270
|
+
|
|
271
|
+
### Authorization
|
|
272
|
+
|
|
273
|
+
No authorization required
|
|
274
|
+
|
|
275
|
+
### HTTP request headers
|
|
276
|
+
|
|
277
|
+
- **Content-Type**: text/plain, application/json
|
|
278
|
+
- **Accept**: application/json
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
# **get_account_by_id**
|
|
283
|
+
> AccountPagedMetadata get_account_by_id(account_id, opts)
|
|
284
|
+
|
|
285
|
+
Returns a single account, specified by the account-ID parameter.
|
|
286
|
+
|
|
287
|
+
{\"nickname\":\"Retrieve an existing account\",\"response\":\"getAccountByID.html\"}
|
|
288
|
+
|
|
289
|
+
### Example
|
|
290
|
+
```ruby
|
|
291
|
+
# load the gem
|
|
292
|
+
require 'bf_ruby2'
|
|
293
|
+
|
|
294
|
+
api_instance = BillForward::AccountsApi.new
|
|
295
|
+
|
|
296
|
+
account_id = "account_id_example" # String |
|
|
297
|
+
|
|
298
|
+
opts = {
|
|
299
|
+
organizations: ["organizations_example"] # Array<String> |
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
begin
|
|
303
|
+
#Returns a single account, specified by the account-ID parameter.
|
|
304
|
+
result = api_instance.get_account_by_id(account_id, opts)
|
|
305
|
+
p result
|
|
306
|
+
rescue BillForward::ApiError => e
|
|
307
|
+
puts "Exception when calling AccountsApi->get_account_by_id: #{e}"
|
|
308
|
+
end
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### Parameters
|
|
312
|
+
|
|
313
|
+
Name | Type | Description | Notes
|
|
314
|
+
------------- | ------------- | ------------- | -------------
|
|
315
|
+
**account_id** | **String**| |
|
|
316
|
+
**organizations** | [**Array<String>**](String.md)| | [optional]
|
|
317
|
+
|
|
318
|
+
### Return type
|
|
319
|
+
|
|
320
|
+
[**AccountPagedMetadata**](AccountPagedMetadata.md)
|
|
321
|
+
|
|
322
|
+
### Authorization
|
|
323
|
+
|
|
324
|
+
No authorization required
|
|
325
|
+
|
|
326
|
+
### HTTP request headers
|
|
327
|
+
|
|
328
|
+
- **Content-Type**: text/plain, application/json
|
|
329
|
+
- **Accept**: application/json
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
# **get_accounts_by_created**
|
|
334
|
+
> AccountPagedMetadata get_accounts_by_created(lower_threshold, upper_threshold, opts)
|
|
335
|
+
|
|
336
|
+
Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
337
|
+
|
|
338
|
+
{\"nickname\":\"Retrieve by creation\",\"response\":\"getAccountByCreated.html\"}
|
|
339
|
+
|
|
340
|
+
### Example
|
|
341
|
+
```ruby
|
|
342
|
+
# load the gem
|
|
343
|
+
require 'bf_ruby2'
|
|
344
|
+
|
|
345
|
+
api_instance = BillForward::AccountsApi.new
|
|
346
|
+
|
|
347
|
+
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
|
348
|
+
|
|
349
|
+
upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.
|
|
350
|
+
|
|
351
|
+
opts = {
|
|
352
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
353
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
354
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
355
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
356
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
357
|
+
include_retired: true # BOOLEAN | Whether retired products should be returned.
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
begin
|
|
361
|
+
#Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
362
|
+
result = api_instance.get_accounts_by_created(lower_threshold, upper_threshold, opts)
|
|
363
|
+
p result
|
|
364
|
+
rescue BillForward::ApiError => e
|
|
365
|
+
puts "Exception when calling AccountsApi->get_accounts_by_created: #{e}"
|
|
366
|
+
end
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
### Parameters
|
|
370
|
+
|
|
371
|
+
Name | Type | Description | Notes
|
|
372
|
+
------------- | ------------- | ------------- | -------------
|
|
373
|
+
**lower_threshold** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
374
|
+
**upper_threshold** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
375
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
376
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
377
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
378
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
379
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
380
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to true]
|
|
381
|
+
|
|
382
|
+
### Return type
|
|
383
|
+
|
|
384
|
+
[**AccountPagedMetadata**](AccountPagedMetadata.md)
|
|
385
|
+
|
|
386
|
+
### Authorization
|
|
387
|
+
|
|
388
|
+
No authorization required
|
|
389
|
+
|
|
390
|
+
### HTTP request headers
|
|
391
|
+
|
|
392
|
+
- **Content-Type**: Not defined
|
|
393
|
+
- **Accept**: text/plain, application/json
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
# **get_accounts_by_updated**
|
|
398
|
+
> AccountPagedMetadata get_accounts_by_updated(lower_threshold, upper_threshold, opts)
|
|
399
|
+
|
|
400
|
+
Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
401
|
+
|
|
402
|
+
{\"nickname\":\"Retrieve by updated\",\"response\":\"getAccountByUpdated.html\"}
|
|
403
|
+
|
|
404
|
+
### Example
|
|
405
|
+
```ruby
|
|
406
|
+
# load the gem
|
|
407
|
+
require 'bf_ruby2'
|
|
408
|
+
|
|
409
|
+
api_instance = BillForward::AccountsApi.new
|
|
410
|
+
|
|
411
|
+
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
|
412
|
+
|
|
413
|
+
upper_threshold = "upper_threshold_example" # String | The UTC DateTime specifying the end of the result period.
|
|
414
|
+
|
|
415
|
+
opts = {
|
|
416
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
417
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
418
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
419
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
420
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
421
|
+
include_retired: true # BOOLEAN | Whether retired products should be returned.
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
begin
|
|
425
|
+
#Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
|
426
|
+
result = api_instance.get_accounts_by_updated(lower_threshold, upper_threshold, opts)
|
|
427
|
+
p result
|
|
428
|
+
rescue BillForward::ApiError => e
|
|
429
|
+
puts "Exception when calling AccountsApi->get_accounts_by_updated: #{e}"
|
|
430
|
+
end
|
|
431
|
+
```
|
|
432
|
+
|
|
433
|
+
### Parameters
|
|
434
|
+
|
|
435
|
+
Name | Type | Description | Notes
|
|
436
|
+
------------- | ------------- | ------------- | -------------
|
|
437
|
+
**lower_threshold** | **String**| The UTC DateTime specifying the start of the result period. |
|
|
438
|
+
**upper_threshold** | **String**| The UTC DateTime specifying the end of the result period. |
|
|
439
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
440
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
441
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
442
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
443
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
444
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to true]
|
|
445
|
+
|
|
446
|
+
### Return type
|
|
447
|
+
|
|
448
|
+
[**AccountPagedMetadata**](AccountPagedMetadata.md)
|
|
449
|
+
|
|
450
|
+
### Authorization
|
|
451
|
+
|
|
452
|
+
No authorization required
|
|
453
|
+
|
|
454
|
+
### HTTP request headers
|
|
455
|
+
|
|
456
|
+
- **Content-Type**: Not defined
|
|
457
|
+
- **Accept**: text/plain, application/json
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
# **get_accounts_by_user_id**
|
|
462
|
+
> AccountPagedMetadata get_accounts_by_user_id(user_id, opts)
|
|
463
|
+
|
|
464
|
+
Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
465
|
+
|
|
466
|
+
{\"nickname\":\"Retrieve by user\",\"response\":\"getAccountByUserID.html\"}
|
|
467
|
+
|
|
468
|
+
### Example
|
|
469
|
+
```ruby
|
|
470
|
+
# load the gem
|
|
471
|
+
require 'bf_ruby2'
|
|
472
|
+
|
|
473
|
+
api_instance = BillForward::AccountsApi.new
|
|
474
|
+
|
|
475
|
+
user_id = "user_id_example" # String |
|
|
476
|
+
|
|
477
|
+
opts = {
|
|
478
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
479
|
+
offset: 0, # Integer | The offset from the first account to return.
|
|
480
|
+
records: 10, # Integer | The maximum number of accounts to return.
|
|
481
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
482
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
483
|
+
include_retired: true # BOOLEAN | Whether retired products should be returned.
|
|
484
|
+
}
|
|
485
|
+
|
|
486
|
+
begin
|
|
487
|
+
#Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
488
|
+
result = api_instance.get_accounts_by_user_id(user_id, opts)
|
|
489
|
+
p result
|
|
490
|
+
rescue BillForward::ApiError => e
|
|
491
|
+
puts "Exception when calling AccountsApi->get_accounts_by_user_id: #{e}"
|
|
492
|
+
end
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
### Parameters
|
|
496
|
+
|
|
497
|
+
Name | Type | Description | Notes
|
|
498
|
+
------------- | ------------- | ------------- | -------------
|
|
499
|
+
**user_id** | **String**| |
|
|
500
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
501
|
+
**offset** | **Integer**| The offset from the first account to return. | [optional] [default to 0]
|
|
502
|
+
**records** | **Integer**| The maximum number of accounts to return. | [optional] [default to 10]
|
|
503
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
504
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
505
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to true]
|
|
506
|
+
|
|
507
|
+
### Return type
|
|
508
|
+
|
|
509
|
+
[**AccountPagedMetadata**](AccountPagedMetadata.md)
|
|
510
|
+
|
|
511
|
+
### Authorization
|
|
512
|
+
|
|
513
|
+
No authorization required
|
|
514
|
+
|
|
515
|
+
### HTTP request headers
|
|
516
|
+
|
|
517
|
+
- **Content-Type**: text/plain, application/json
|
|
518
|
+
- **Accept**: application/json
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
# **get_all_accounts**
|
|
523
|
+
> AccountPagedMetadata get_all_accounts(opts)
|
|
524
|
+
|
|
525
|
+
Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order.
|
|
526
|
+
|
|
527
|
+
{\"nickname\":\"Get all accounts\",\"response\":\"getAccountAll.html\"}
|
|
528
|
+
|
|
529
|
+
### Example
|
|
530
|
+
```ruby
|
|
531
|
+
# load the gem
|
|
532
|
+
require 'bf_ruby2'
|
|
533
|
+
|
|
534
|
+
api_instance = BillForward::AccountsApi.new
|
|
535
|
+
|
|
536
|
+
opts = {
|
|
537
|
+
id: ["id_example"], # Array<String> | A list of account IDs used to filter the output.
|
|
538
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
539
|
+
offset: 0, # Integer | The offset from the first taxation-link to return.
|
|
540
|
+
records: 10, # Integer | The maximum number of taxation-links to return.
|
|
541
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
542
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
543
|
+
include_retired: true, # BOOLEAN | Whether retired products should be returned.
|
|
544
|
+
users_only: false, # BOOLEAN | Whether only accounts have a user should be returned.
|
|
545
|
+
metadata: "metadata_example" # String |
|
|
546
|
+
}
|
|
547
|
+
|
|
548
|
+
begin
|
|
549
|
+
#Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order.
|
|
550
|
+
result = api_instance.get_all_accounts(opts)
|
|
551
|
+
p result
|
|
552
|
+
rescue BillForward::ApiError => e
|
|
553
|
+
puts "Exception when calling AccountsApi->get_all_accounts: #{e}"
|
|
554
|
+
end
|
|
555
|
+
```
|
|
556
|
+
|
|
557
|
+
### Parameters
|
|
558
|
+
|
|
559
|
+
Name | Type | Description | Notes
|
|
560
|
+
------------- | ------------- | ------------- | -------------
|
|
561
|
+
**id** | [**Array<String>**](String.md)| A list of account IDs used to filter the output. | [optional]
|
|
562
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
563
|
+
**offset** | **Integer**| The offset from the first taxation-link to return. | [optional] [default to 0]
|
|
564
|
+
**records** | **Integer**| The maximum number of taxation-links to return. | [optional] [default to 10]
|
|
565
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
566
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
567
|
+
**include_retired** | **BOOLEAN**| Whether retired products should be returned. | [optional] [default to true]
|
|
568
|
+
**users_only** | **BOOLEAN**| Whether only accounts have a user should be returned. | [optional] [default to false]
|
|
569
|
+
**metadata** | **String**| | [optional]
|
|
570
|
+
|
|
571
|
+
### Return type
|
|
572
|
+
|
|
573
|
+
[**AccountPagedMetadata**](AccountPagedMetadata.md)
|
|
574
|
+
|
|
575
|
+
### Authorization
|
|
576
|
+
|
|
577
|
+
No authorization required
|
|
578
|
+
|
|
579
|
+
### HTTP request headers
|
|
580
|
+
|
|
581
|
+
- **Content-Type**: Not defined
|
|
582
|
+
- **Accept**: text/plain, application/json
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
# **get_available_credit_on_account**
|
|
587
|
+
> CreditNotePagedMetadata get_available_credit_on_account(account_id, opts)
|
|
588
|
+
|
|
589
|
+
Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order.
|
|
590
|
+
|
|
591
|
+
{\"nickname\":\"Get available credit\",\"response\":\"getAvailableCreditAccount.html\"}
|
|
592
|
+
|
|
593
|
+
### Example
|
|
594
|
+
```ruby
|
|
595
|
+
# load the gem
|
|
596
|
+
require 'bf_ruby2'
|
|
597
|
+
|
|
598
|
+
api_instance = BillForward::AccountsApi.new
|
|
599
|
+
|
|
600
|
+
account_id = "account_id_example" # String | The ID of the account
|
|
601
|
+
|
|
602
|
+
opts = {
|
|
603
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
604
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
605
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
606
|
+
order_by: "id", # String | Specify a field used to order the result set.
|
|
607
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
608
|
+
include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
|
|
609
|
+
}
|
|
610
|
+
|
|
611
|
+
begin
|
|
612
|
+
#Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order.
|
|
613
|
+
result = api_instance.get_available_credit_on_account(account_id, opts)
|
|
614
|
+
p result
|
|
615
|
+
rescue BillForward::ApiError => e
|
|
616
|
+
puts "Exception when calling AccountsApi->get_available_credit_on_account: #{e}"
|
|
617
|
+
end
|
|
618
|
+
```
|
|
619
|
+
|
|
620
|
+
### Parameters
|
|
621
|
+
|
|
622
|
+
Name | Type | Description | Notes
|
|
623
|
+
------------- | ------------- | ------------- | -------------
|
|
624
|
+
**account_id** | **String**| The ID of the account |
|
|
625
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
626
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
627
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
628
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to id]
|
|
629
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
630
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
631
|
+
|
|
632
|
+
### Return type
|
|
633
|
+
|
|
634
|
+
[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md)
|
|
635
|
+
|
|
636
|
+
### Authorization
|
|
637
|
+
|
|
638
|
+
No authorization required
|
|
639
|
+
|
|
640
|
+
### HTTP request headers
|
|
641
|
+
|
|
642
|
+
- **Content-Type**: text/plain, application/json
|
|
643
|
+
- **Accept**: application/json
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
# **get_metadata_for_account**
|
|
648
|
+
> DynamicMetadata get_metadata_for_account(account_id, opts)
|
|
649
|
+
|
|
650
|
+
Retrieve any associated metadata.
|
|
651
|
+
|
|
652
|
+
{\"nickname\":\"Retrieve metadata on account\",\"request\":\"getAccountMetadataRequest.html\",\"response\":\"getAccountMetadataResponse.html\"}
|
|
653
|
+
|
|
654
|
+
### Example
|
|
655
|
+
```ruby
|
|
656
|
+
# load the gem
|
|
657
|
+
require 'bf_ruby2'
|
|
658
|
+
|
|
659
|
+
api_instance = BillForward::AccountsApi.new
|
|
660
|
+
|
|
661
|
+
account_id = "account_id_example" # String |
|
|
662
|
+
|
|
663
|
+
opts = {
|
|
664
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
begin
|
|
668
|
+
#Retrieve any associated metadata.
|
|
669
|
+
result = api_instance.get_metadata_for_account(account_id, opts)
|
|
670
|
+
p result
|
|
671
|
+
rescue BillForward::ApiError => e
|
|
672
|
+
puts "Exception when calling AccountsApi->get_metadata_for_account: #{e}"
|
|
673
|
+
end
|
|
674
|
+
```
|
|
675
|
+
|
|
676
|
+
### Parameters
|
|
677
|
+
|
|
678
|
+
Name | Type | Description | Notes
|
|
679
|
+
------------- | ------------- | ------------- | -------------
|
|
680
|
+
**account_id** | **String**| |
|
|
681
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
682
|
+
|
|
683
|
+
### Return type
|
|
684
|
+
|
|
685
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
686
|
+
|
|
687
|
+
### Authorization
|
|
688
|
+
|
|
689
|
+
No authorization required
|
|
690
|
+
|
|
691
|
+
### HTTP request headers
|
|
692
|
+
|
|
693
|
+
- **Content-Type**: text/plain, application/json
|
|
694
|
+
- **Accept**: application/json
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
# **get_permissions_on_account**
|
|
699
|
+
> RolePagedMetadata get_permissions_on_account(account_id, opts)
|
|
700
|
+
|
|
701
|
+
Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
702
|
+
|
|
703
|
+
{\"nickname\":\"List roles on account\",\"response\":\"getRoleByAccount.html\"}
|
|
704
|
+
|
|
705
|
+
### Example
|
|
706
|
+
```ruby
|
|
707
|
+
# load the gem
|
|
708
|
+
require 'bf_ruby2'
|
|
709
|
+
|
|
710
|
+
api_instance = BillForward::AccountsApi.new
|
|
711
|
+
|
|
712
|
+
account_id = "account_id_example" # String |
|
|
713
|
+
|
|
714
|
+
opts = {
|
|
715
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
716
|
+
offset: 0, # Integer | The offset from the first subscription to return.
|
|
717
|
+
records: 10, # Integer | The maximum number of subscriptions to return.
|
|
718
|
+
order_by: "id", # String | Specify a field used to order the result set.
|
|
719
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
720
|
+
include_retired: false # BOOLEAN | Whether retired subscriptions should be returned.
|
|
721
|
+
}
|
|
722
|
+
|
|
723
|
+
begin
|
|
724
|
+
#Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
|
725
|
+
result = api_instance.get_permissions_on_account(account_id, opts)
|
|
726
|
+
p result
|
|
727
|
+
rescue BillForward::ApiError => e
|
|
728
|
+
puts "Exception when calling AccountsApi->get_permissions_on_account: #{e}"
|
|
729
|
+
end
|
|
730
|
+
```
|
|
731
|
+
|
|
732
|
+
### Parameters
|
|
733
|
+
|
|
734
|
+
Name | Type | Description | Notes
|
|
735
|
+
------------- | ------------- | ------------- | -------------
|
|
736
|
+
**account_id** | **String**| |
|
|
737
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
738
|
+
**offset** | **Integer**| The offset from the first subscription to return. | [optional] [default to 0]
|
|
739
|
+
**records** | **Integer**| The maximum number of subscriptions to return. | [optional] [default to 10]
|
|
740
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to id]
|
|
741
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
742
|
+
**include_retired** | **BOOLEAN**| Whether retired subscriptions should be returned. | [optional] [default to false]
|
|
743
|
+
|
|
744
|
+
### Return type
|
|
745
|
+
|
|
746
|
+
[**RolePagedMetadata**](RolePagedMetadata.md)
|
|
747
|
+
|
|
748
|
+
### Authorization
|
|
749
|
+
|
|
750
|
+
No authorization required
|
|
751
|
+
|
|
752
|
+
### HTTP request headers
|
|
753
|
+
|
|
754
|
+
- **Content-Type**: text/plain
|
|
755
|
+
- **Accept**: application/json
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
# **remove_credit_from_account**
|
|
760
|
+
> CreditNotePagedMetadata remove_credit_from_account(account_id, value, opts)
|
|
761
|
+
|
|
762
|
+
Decrease the amount of credit by the value specified or entirely if no value provided.
|
|
763
|
+
|
|
764
|
+
{\"nickname\":\"Remove Credit\",\"response\":\"removeCreditForAccount.html\"}
|
|
765
|
+
|
|
766
|
+
### Example
|
|
767
|
+
```ruby
|
|
768
|
+
# load the gem
|
|
769
|
+
require 'bf_ruby2'
|
|
770
|
+
|
|
771
|
+
api_instance = BillForward::AccountsApi.new
|
|
772
|
+
|
|
773
|
+
account_id = "account_id_example" # String |
|
|
774
|
+
|
|
775
|
+
value = "value_example" # String | <p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed from this credit note.</p><p>If a currency value is provided the format should be in the form of valueCurrency, where value is the value to remove. The currency should be an ISO 4217 Currency Code. For example setting the value as 10USD will reduce the credit on this account by $10 or 9.86USD would reduce the credit by $9.86. Note: the value will be reduced from any credit notes with available balance.</p>
|
|
776
|
+
|
|
777
|
+
opts = {
|
|
778
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
779
|
+
}
|
|
780
|
+
|
|
781
|
+
begin
|
|
782
|
+
#Decrease the amount of credit by the value specified or entirely if no value provided.
|
|
783
|
+
result = api_instance.remove_credit_from_account(account_id, value, opts)
|
|
784
|
+
p result
|
|
785
|
+
rescue BillForward::ApiError => e
|
|
786
|
+
puts "Exception when calling AccountsApi->remove_credit_from_account: #{e}"
|
|
787
|
+
end
|
|
788
|
+
```
|
|
789
|
+
|
|
790
|
+
### Parameters
|
|
791
|
+
|
|
792
|
+
Name | Type | Description | Notes
|
|
793
|
+
------------- | ------------- | ------------- | -------------
|
|
794
|
+
**account_id** | **String**| |
|
|
795
|
+
**value** | **String**| <p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed from this credit note.</p><p>If a currency value is provided the format should be in the form of valueCurrency, where value is the value to remove. The currency should be an ISO 4217 Currency Code. For example setting the value as 10USD will reduce the credit on this account by $10 or 9.86USD would reduce the credit by $9.86. Note: the value will be reduced from any credit notes with available balance.</p> |
|
|
796
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
797
|
+
|
|
798
|
+
### Return type
|
|
799
|
+
|
|
800
|
+
[**CreditNotePagedMetadata**](CreditNotePagedMetadata.md)
|
|
801
|
+
|
|
802
|
+
### Authorization
|
|
803
|
+
|
|
804
|
+
No authorization required
|
|
805
|
+
|
|
806
|
+
### HTTP request headers
|
|
807
|
+
|
|
808
|
+
- **Content-Type**: text/plain, application/json
|
|
809
|
+
- **Accept**: application/json
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
# **remove_permission_from_account**
|
|
814
|
+
> RolePagedMetadata remove_permission_from_account(account_id, role, opts)
|
|
815
|
+
|
|
816
|
+
Revoke the specified role.
|
|
817
|
+
|
|
818
|
+
{\"nickname\":\"Remove Role\",\"response\":\"removeRoleFromAccount.html\"}
|
|
819
|
+
|
|
820
|
+
### Example
|
|
821
|
+
```ruby
|
|
822
|
+
# load the gem
|
|
823
|
+
require 'bf_ruby2'
|
|
824
|
+
|
|
825
|
+
api_instance = BillForward::AccountsApi.new
|
|
826
|
+
|
|
827
|
+
account_id = "account_id_example" # String |
|
|
828
|
+
|
|
829
|
+
role = "role_example" # String | ID or name of the role.
|
|
830
|
+
|
|
831
|
+
opts = {
|
|
832
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
833
|
+
}
|
|
834
|
+
|
|
835
|
+
begin
|
|
836
|
+
#Revoke the specified role.
|
|
837
|
+
result = api_instance.remove_permission_from_account(account_id, role, opts)
|
|
838
|
+
p result
|
|
839
|
+
rescue BillForward::ApiError => e
|
|
840
|
+
puts "Exception when calling AccountsApi->remove_permission_from_account: #{e}"
|
|
841
|
+
end
|
|
842
|
+
```
|
|
843
|
+
|
|
844
|
+
### Parameters
|
|
845
|
+
|
|
846
|
+
Name | Type | Description | Notes
|
|
847
|
+
------------- | ------------- | ------------- | -------------
|
|
848
|
+
**account_id** | **String**| |
|
|
849
|
+
**role** | **String**| ID or name of the role. |
|
|
850
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
851
|
+
|
|
852
|
+
### Return type
|
|
853
|
+
|
|
854
|
+
[**RolePagedMetadata**](RolePagedMetadata.md)
|
|
855
|
+
|
|
856
|
+
### Authorization
|
|
857
|
+
|
|
858
|
+
No authorization required
|
|
859
|
+
|
|
860
|
+
### HTTP request headers
|
|
861
|
+
|
|
862
|
+
- **Content-Type**: text/plain
|
|
863
|
+
- **Accept**: application/json
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
# **set_metadata_for_account**
|
|
868
|
+
> DynamicMetadata set_metadata_for_account(metadata, account_id, opts)
|
|
869
|
+
|
|
870
|
+
Remove any existing metadata keys and create the provided data.
|
|
871
|
+
|
|
872
|
+
{\"nickname\":\"Set metadata on account\",\"request\":\"setAccountMetadataRequest.html\",\"response\":\"setAccountMetadataResponse.html\"}
|
|
873
|
+
|
|
874
|
+
### Example
|
|
875
|
+
```ruby
|
|
876
|
+
# load the gem
|
|
877
|
+
require 'bf_ruby2'
|
|
878
|
+
|
|
879
|
+
api_instance = BillForward::AccountsApi.new
|
|
880
|
+
|
|
881
|
+
metadata = BillForward::DynamicMetadata.new # DynamicMetadata |
|
|
882
|
+
|
|
883
|
+
account_id = "account_id_example" # String |
|
|
884
|
+
|
|
885
|
+
opts = {
|
|
886
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
887
|
+
}
|
|
888
|
+
|
|
889
|
+
begin
|
|
890
|
+
#Remove any existing metadata keys and create the provided data.
|
|
891
|
+
result = api_instance.set_metadata_for_account(metadata, account_id, opts)
|
|
892
|
+
p result
|
|
893
|
+
rescue BillForward::ApiError => e
|
|
894
|
+
puts "Exception when calling AccountsApi->set_metadata_for_account: #{e}"
|
|
895
|
+
end
|
|
896
|
+
```
|
|
897
|
+
|
|
898
|
+
### Parameters
|
|
899
|
+
|
|
900
|
+
Name | Type | Description | Notes
|
|
901
|
+
------------- | ------------- | ------------- | -------------
|
|
902
|
+
**metadata** | [**DynamicMetadata**](DynamicMetadata.md)| |
|
|
903
|
+
**account_id** | **String**| |
|
|
904
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
905
|
+
|
|
906
|
+
### Return type
|
|
907
|
+
|
|
908
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
909
|
+
|
|
910
|
+
### Authorization
|
|
911
|
+
|
|
912
|
+
No authorization required
|
|
913
|
+
|
|
914
|
+
### HTTP request headers
|
|
915
|
+
|
|
916
|
+
- **Content-Type**: application/json
|
|
917
|
+
- **Accept**: application/json
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
# **update_account**
|
|
922
|
+
> AccountPagedMetadata update_account(account)
|
|
923
|
+
|
|
924
|
+
Update an Account.
|
|
925
|
+
|
|
926
|
+
{\"nickname\":\"Update an account\",\"response\":\"updateAccountResponse.html\",\"request\":\"updateAccountRequest.html\"}
|
|
927
|
+
|
|
928
|
+
### Example
|
|
929
|
+
```ruby
|
|
930
|
+
# load the gem
|
|
931
|
+
require 'bf_ruby2'
|
|
932
|
+
|
|
933
|
+
api_instance = BillForward::AccountsApi.new
|
|
934
|
+
|
|
935
|
+
account = BillForward::Account.new # Account | The account object to be created.
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
begin
|
|
939
|
+
#Update an Account.
|
|
940
|
+
result = api_instance.update_account(account)
|
|
941
|
+
p result
|
|
942
|
+
rescue BillForward::ApiError => e
|
|
943
|
+
puts "Exception when calling AccountsApi->update_account: #{e}"
|
|
944
|
+
end
|
|
945
|
+
```
|
|
946
|
+
|
|
947
|
+
### Parameters
|
|
948
|
+
|
|
949
|
+
Name | Type | Description | Notes
|
|
950
|
+
------------- | ------------- | ------------- | -------------
|
|
951
|
+
**account** | [**Account**](Account.md)| The account object to be created. |
|
|
952
|
+
|
|
953
|
+
### Return type
|
|
954
|
+
|
|
955
|
+
[**AccountPagedMetadata**](AccountPagedMetadata.md)
|
|
956
|
+
|
|
957
|
+
### Authorization
|
|
958
|
+
|
|
959
|
+
No authorization required
|
|
960
|
+
|
|
961
|
+
### HTTP request headers
|
|
962
|
+
|
|
963
|
+
- **Content-Type**: application/json
|
|
964
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
# **upsert_metadata_for_account**
|
|
969
|
+
> DynamicMetadata upsert_metadata_for_account(metadata, account_id, opts)
|
|
970
|
+
|
|
971
|
+
Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
972
|
+
|
|
973
|
+
{\"nickname\":\"Upsert metadata on account\",\"request\":\"upsertAccountMetadataRequest.html\",\"response\":\"upsertAccountMetadataResponse.html\"}
|
|
974
|
+
|
|
975
|
+
### Example
|
|
976
|
+
```ruby
|
|
977
|
+
# load the gem
|
|
978
|
+
require 'bf_ruby2'
|
|
979
|
+
|
|
980
|
+
api_instance = BillForward::AccountsApi.new
|
|
981
|
+
|
|
982
|
+
metadata = BillForward::DynamicMetadata.new # DynamicMetadata |
|
|
983
|
+
|
|
984
|
+
account_id = "account_id_example" # String |
|
|
985
|
+
|
|
986
|
+
opts = {
|
|
987
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
988
|
+
}
|
|
989
|
+
|
|
990
|
+
begin
|
|
991
|
+
#Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
|
992
|
+
result = api_instance.upsert_metadata_for_account(metadata, account_id, opts)
|
|
993
|
+
p result
|
|
994
|
+
rescue BillForward::ApiError => e
|
|
995
|
+
puts "Exception when calling AccountsApi->upsert_metadata_for_account: #{e}"
|
|
996
|
+
end
|
|
997
|
+
```
|
|
998
|
+
|
|
999
|
+
### Parameters
|
|
1000
|
+
|
|
1001
|
+
Name | Type | Description | Notes
|
|
1002
|
+
------------- | ------------- | ------------- | -------------
|
|
1003
|
+
**metadata** | [**DynamicMetadata**](DynamicMetadata.md)| |
|
|
1004
|
+
**account_id** | **String**| |
|
|
1005
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
1006
|
+
|
|
1007
|
+
### Return type
|
|
1008
|
+
|
|
1009
|
+
[**DynamicMetadata**](DynamicMetadata.md)
|
|
1010
|
+
|
|
1011
|
+
### Authorization
|
|
1012
|
+
|
|
1013
|
+
No authorization required
|
|
1014
|
+
|
|
1015
|
+
### HTTP request headers
|
|
1016
|
+
|
|
1017
|
+
- **Content-Type**: application/json
|
|
1018
|
+
- **Accept**: application/json
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
|