bf_ruby2 1.2016.230 → 2.2016.237
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +710 -710
- data/bf-ruby2.iml +6 -0
- data/bf_ruby2-1.2016.230.gem +0 -0
- data/bf_ruby2.gemspec +1 -1
- data/docs/APIConfigurationPagedMetadata.md +1 -1
- data/docs/APIQuote.md +1 -1
- data/docs/APIQuotePagedMetadata.md +1 -1
- data/docs/APIQuoteResponseQuantity.md +1 -1
- data/docs/Account.md +1 -1
- data/docs/AccountLTVResultPagedMetadata.md +1 -1
- data/docs/AccountPagedMetadata.md +1 -1
- data/docs/AccountPaymentsResultPagedMetadata.md +1 -1
- data/docs/AccountsApi.md +45 -45
- data/docs/AddChargeRequest.md +1 -1
- data/docs/AddChargeToAccountResponse.md +1 -1
- data/docs/AddChargeToAccountResponsePagedMetadata.md +1 -1
- data/docs/AddChargesToAccountAPIRequest.md +1 -1
- data/docs/AddCouponCodeRequest.md +1 -1
- data/docs/AddPaymentMethodRequest.md +1 -1
- data/docs/AddTaxationStrategyRequest.md +1 -1
- data/docs/Address.md +1 -1
- data/docs/AddressPagedMetadata.md +1 -1
- data/docs/AddressesApi.md +7 -7
- data/docs/AggregatingComponent.md +1 -1
- data/docs/Amendment.md +1 -1
- data/docs/AmendmentDiscardAmendment.md +1 -1
- data/docs/AmendmentPagedMetadata.md +1 -1
- data/docs/AmendmentPriceNTimePagedMetadata.md +1 -1
- data/docs/AmendmentsApi.md +25 -25
- data/docs/AnalyticsApi.md +27 -27
- data/docs/AuditEntry.md +1 -1
- data/docs/AuditEntryPagedMetadata.md +1 -1
- data/docs/AuditlogsApi.md +11 -11
- data/docs/AuthCaptureRequest.md +1 -1
- data/docs/AuthorizeNetTokenPagedMetadata.md +1 -1
- data/docs/BFError.md +1 -1
- data/docs/BFPermission.md +1 -1
- data/docs/BFPermissionPagedMetadata.md +1 -1
- data/docs/BankAccountVerificationPagedMetadata.md +1 -1
- data/docs/BatchUpdatePricingComponentValuesRequest.md +1 -1
- data/docs/BillforwardManagedPaymentsResultPagedMetadata.md +1 -1
- data/docs/BillingEntityBase.md +1 -1
- data/docs/BraintreeAuthCaptureRequest.md +1 -1
- data/docs/BraintreeCaptureRequest.md +1 -1
- data/docs/BraintreeTokenPagedMetadata.md +1 -1
- data/docs/CancelSubscriptionRequest.md +1 -1
- data/docs/CancellationAmendment.md +1 -1
- data/docs/CassChurnResultPagedMetadata.md +1 -1
- data/docs/CassPaymentResultPagedMetadata.md +1 -1
- data/docs/CassUpgradeResultPagedMetadata.md +1 -1
- data/docs/ChargesApi.md +19 -19
- data/docs/Client.md +1 -1
- data/docs/ClientPagedMetadata.md +1 -1
- data/docs/ClientsApi.md +11 -11
- data/docs/ComponentChange.md +1 -1
- data/docs/ComponentCost.md +1 -1
- data/docs/CompoundUsage.md +1 -1
- data/docs/CompoundUsageSession.md +1 -1
- data/docs/ConfigurationsApi.md +11 -11
- data/docs/Coupon.md +1 -1
- data/docs/CouponBook.md +1 -1
- data/docs/CouponBookDefinition.md +1 -1
- data/docs/CouponBookDefinitionPagedMetadata.md +1 -1
- data/docs/CouponBookPagedMetadata.md +1 -1
- data/docs/CouponDefinition.md +1 -1
- data/docs/CouponDefinitionPagedMetadata.md +1 -1
- data/docs/CouponDiscount.md +1 -1
- data/docs/CouponDiscountEstimate.md +1 -1
- data/docs/CouponInstance.md +1 -1
- data/docs/CouponInstanceExistingValue.md +1 -1
- data/docs/CouponInstancePagedMetadata.md +1 -1
- data/docs/CouponModifierBase.md +1 -1
- data/docs/CouponModifierBasePagedMetadata.md +1 -1
- data/docs/CouponPagedMetadata.md +1 -1
- data/docs/CouponRule.md +1 -1
- data/docs/CouponRulePagedMetadata.md +1 -1
- data/docs/CouponUniqueCodesRequest.md +1 -1
- data/docs/CouponUniqueCodesResponse.md +1 -1
- data/docs/CouponUniqueCodesResponsePagedMetadata.md +1 -1
- data/docs/CouponWrapperResponse.md +1 -1
- data/docs/CouponbookApi.md +21 -21
- data/docs/CouponbookdefinitionApi.md +15 -15
- data/docs/CoupondefinitionApi.md +13 -13
- data/docs/CouponinstanceApi.md +23 -23
- data/docs/CouponmodifierApi.md +17 -17
- data/docs/CouponruleApi.md +12 -12
- data/docs/CouponsApi.md +19 -19
- data/docs/CreateAccountProfileRequest.md +1 -1
- data/docs/CreateAccountRequest.md +1 -1
- data/docs/CreateAddressRequest.md +1 -1
- data/docs/CreateAggregatingComponentRequest.md +1 -1
- data/docs/CreateAggregatingSubscriptionRequest.md +1 -1
- data/docs/CreateProfileAddressRequest.md +1 -1
- data/docs/CreateSubscriptionBatchRequest.md +1 -1
- data/docs/CreateSubscriptionChargeAmendment.md +1 -1
- data/docs/CreateSubscriptionRequest.md +1 -1
- data/docs/CreditAccountRequest.md +1 -1
- data/docs/CreditNote.md +1 -1
- data/docs/CreditNotePagedMetadata.md +1 -1
- data/docs/CreditSubscriptionRequest.md +1 -1
- data/docs/CreditnotesApi.md +14 -14
- data/docs/CybersourceTokenPagedMetadata.md +1 -1
- data/docs/CybersourcetokensApi.md +13 -13
- data/docs/DataSynchronisationAppConfigurationPagedMetadata.md +1 -1
- data/docs/DataSynchronisationConfiguration.md +1 -1
- data/docs/DataSynchronisationConfigurationPagedMetadata.md +1 -1
- data/docs/DataSynchronizationJobPagedMetadata.md +1 -1
- data/docs/DebtsResultPagedMetadata.md +1 -1
- data/docs/DunningLine.md +1 -1
- data/docs/DunningLinePagedMetadata.md +1 -1
- data/docs/DunninglinesApi.md +15 -15
- data/docs/DynamicMetadata.md +1 -1
- data/docs/Email.md +1 -1
- data/docs/EmailPagedMetadata.md +1 -1
- data/docs/EmailProvider.md +1 -1
- data/docs/EmailProviderPagedMetadata.md +1 -1
- data/docs/EmailSubscription.md +1 -1
- data/docs/EmailSubscriptionPagedMetadata.md +1 -1
- data/docs/EmailprovidersApi.md +10 -10
- data/docs/EmailsApi.md +7 -7
- data/docs/EmailsubscriptionsApi.md +13 -13
- data/docs/EndTrialAmendment.md +1 -1
- data/docs/Event.md +1 -1
- data/docs/EventData.md +1 -1
- data/docs/FileSham.md +1 -1
- data/docs/FixedTerm.md +1 -1
- data/docs/FixedTermDefinitionPagedMetadata.md +1 -1
- data/docs/FixedTermExpiryAmendment.md +1 -1
- data/docs/FixedTermPagedMetadata.md +1 -1
- data/docs/FixedtermdefinitionsApi.md +7 -7
- data/docs/FixedtermsApi.md +4 -4
- data/docs/FlatPricingComponent.md +1 -1
- data/docs/ImportInvoiceLine.md +1 -1
- data/docs/InsertableBillingEntity.md +1 -1
- data/docs/Invoice.md +1 -1
- data/docs/InvoiceChargeRequest.md +1 -1
- data/docs/InvoiceLine.md +1 -1
- data/docs/InvoiceLinePayment.md +1 -1
- data/docs/InvoiceLinePaymentPagedMetadata.md +1 -1
- data/docs/InvoiceNextExecutionAttemptAmendment.md +1 -1
- data/docs/InvoiceOutstandingChargesAmendment.md +1 -1
- data/docs/InvoicePagedMetadata.md +1 -1
- data/docs/InvoicePayment.md +1 -1
- data/docs/InvoiceRecalculationAmendment.md +1 -1
- data/docs/InvoiceRecalculationRequest.md +1 -1
- data/docs/InvoicesApi.md +95 -95
- data/docs/IssueInvoiceAmendment.md +1 -1
- data/docs/MetadataApi.md +11 -11
- data/docs/MetadataKeyValuesPagedMetadata.md +1 -1
- data/docs/MigrationRequest.md +1 -1
- data/docs/ModelAlias.md +1 -1
- data/docs/MutableBillingEntity.md +1 -1
- data/docs/NestedChargeRequest.md +1 -1
- data/docs/Notification.md +1 -1
- data/docs/NotificationPagedMetadata.md +1 -1
- data/docs/NotificationsApi.md +13 -13
- data/docs/Organization.md +1 -1
- data/docs/OrganizationPagedMetadata.md +1 -1
- data/docs/OrganizationsApi.md +17 -17
- data/docs/Password.md +1 -1
- data/docs/PasswordPagedMetadata.md +1 -1
- data/docs/PasswordResetRequest.md +1 -1
- data/docs/PasswordsApi.md +4 -4
- data/docs/PauseRequest.md +1 -1
- data/docs/Payment.md +1 -1
- data/docs/PaymentMethod.md +1 -1
- data/docs/PaymentMethodPagedMetadata.md +1 -1
- data/docs/PaymentMethodSubscriptionLink.md +1 -1
- data/docs/PaymentMethodSubscriptionLinkPagedMetadata.md +1 -1
- data/docs/PaymentPagedMetadata.md +1 -1
- data/docs/PaymentRetryRequest.md +1 -1
- data/docs/PaymentmethodsApi.md +19 -19
- data/docs/PaymentmethodsubscriptionlinksApi.md +6 -6
- data/docs/PaymentsApi.md +19 -19
- data/docs/PendingComponentValueChange.md +1 -1
- data/docs/Period.md +1 -1
- data/docs/PeriodPagedMetadata.md +1 -1
- data/docs/PeriodsApi.md +5 -5
- data/docs/PermissionActionEntityPagedMetadata.md +1 -1
- data/docs/PermissionResourceEntityPagedMetadata.md +1 -1
- data/docs/PermissionsApi.md +14 -14
- data/docs/PriceCalculationPagedMetadata.md +1 -1
- data/docs/PricingComponent.md +1 -1
- data/docs/PricingComponentCouponModifier.md +1 -1
- data/docs/PricingComponentMigrationValue.md +1 -1
- data/docs/PricingComponentPagedMetadata.md +1 -1
- data/docs/PricingComponentQuantityRequest.md +1 -1
- data/docs/PricingComponentTier.md +1 -1
- data/docs/PricingComponentTierPagedMetadata.md +1 -1
- data/docs/PricingComponentValue.md +1 -1
- data/docs/PricingComponentValueChangeAmendment.md +1 -1
- data/docs/PricingComponentValueChangePagedMetadata.md +1 -1
- data/docs/PricingComponentValueMigrationAmendmentMapping.md +1 -1
- data/docs/PricingComponentValuePagedMetadata.md +1 -1
- data/docs/PricingComponentValueRequest.md +1 -1
- data/docs/PricingComponentValueResponsePagedMetadata.md +1 -1
- data/docs/PricingcalculatorApi.md +10 -10
- data/docs/PricingcomponentsApi.md +15 -15
- data/docs/PricingcomponenttiersApi.md +13 -13
- data/docs/PricingcomponentvaluechangesApi.md +14 -14
- data/docs/PricingcomponentvaluesApi.md +13 -13
- data/docs/Product.md +2 -2
- data/docs/ProductCouponModifier.md +1 -1
- data/docs/ProductPagedMetadata.md +1 -1
- data/docs/ProductPaymentsResultPagedMetadata.md +1 -1
- data/docs/ProductRatePlan.md +2 -2
- data/docs/ProductRatePlanMigrationAmendment.md +1 -1
- data/docs/ProductRatePlanPagedMetadata.md +1 -1
- data/docs/ProductRatePlanPaymentsResultPagedMetadata.md +1 -1
- data/docs/ProductrateplansApi.md +34 -34
- data/docs/ProductsApi.md +23 -23
- data/docs/Profile.md +1 -1
- data/docs/ProfilePagedMetadata.md +1 -1
- data/docs/ProfilesApi.md +12 -12
- data/docs/QuoteRequest.md +1 -1
- data/docs/QuoteRequestValue.md +1 -1
- data/docs/QuotesApi.md +4 -4
- data/docs/RecalculateChargeBatchRequest.md +1 -1
- data/docs/RecalculateChargeBatchResponse.md +1 -1
- data/docs/RecalculateChargeBatchResponsePagedMetadata.md +1 -1
- data/docs/RecalculateChargeRequest.md +1 -1
- data/docs/Receipt.md +1 -1
- data/docs/ReceiptPagedMetadata.md +1 -1
- data/docs/ReceiptsApi.md +16 -16
- data/docs/Refund.md +1 -1
- data/docs/RefundPagedMetadata.md +1 -1
- data/docs/RefundsApi.md +19 -19
- data/docs/ResumeRequest.md +1 -1
- data/docs/ResumeSubscriptionAmendment.md +1 -1
- data/docs/RevenueAttribution.md +1 -1
- data/docs/RevenueAttributionPagedMetadata.md +1 -1
- data/docs/ReviveSubscriptionRequest.md +1 -1
- data/docs/Role.md +1 -1
- data/docs/RolePagedMetadata.md +1 -1
- data/docs/RolesApi.md +15 -15
- data/docs/RuleSatisfaction.md +1 -1
- data/docs/SearchApi.md +3 -3
- data/docs/SearchResultPagedMetadata.md +1 -1
- data/docs/ServiceEndAmendment.md +1 -1
- data/docs/SingleRecalculateChargeRequest.md +1 -1
- data/docs/StripeACHTokenPagedMetadata.md +1 -1
- data/docs/StripeAuthCaptureRequest.md +1 -1
- data/docs/StripeObject.md +1 -1
- data/docs/StripeTokenPagedMetadata.md +1 -1
- data/docs/Subscription.md +1 -1
- data/docs/SubscriptionCancellationPagedMetadata.md +1 -1
- data/docs/SubscriptionCharge.md +1 -1
- data/docs/SubscriptionChargePagedMetadata.md +1 -1
- data/docs/SubscriptionLTVResultPagedMetadata.md +1 -1
- data/docs/SubscriptionPagedMetadata.md +1 -1
- data/docs/SubscriptionsApi.md +129 -129
- data/docs/SwaggerTypeList.md +1 -1
- data/docs/SwaggerTypeListInv.md +1 -1
- data/docs/SwaggerTypeListSubs.md +1 -1
- data/docs/SynchAppConfigsApi.md +11 -11
- data/docs/SynchConfigsApi.md +15 -15
- data/docs/SynchJobsApi.md +19 -19
- data/docs/TaxationLinkPagedMetadata.md +1 -1
- data/docs/TaxationStrategyPagedMetadata.md +1 -1
- data/docs/TaxationlinksApi.md +15 -15
- data/docs/TaxationstrategiesApi.md +21 -21
- data/docs/TieredPricingComponent.md +1 -1
- data/docs/TieredVolumePricingComponent.md +1 -1
- data/docs/TimeApi.md +4 -4
- data/docs/TimeRequest.md +1 -1
- data/docs/TimeResponse.md +1 -1
- data/docs/TimeResponsePagedMetadata.md +1 -1
- data/docs/TimeZone.md +1 -1
- data/docs/TimerAmendment.md +1 -1
- data/docs/TokenizationApi.md +20 -20
- data/docs/TokenizationPreAuthPagedMetadata.md +1 -1
- data/docs/TrustCommerceTokenPagedMetadata.md +1 -1
- data/docs/UnitDiscount.md +1 -1
- data/docs/UnitOfMeasure.md +1 -1
- data/docs/UnitOfMeasureCouponModifier.md +1 -1
- data/docs/UnitOfMeasurePagedMetadata.md +1 -1
- data/docs/UnitofmeasureApi.md +11 -11
- data/docs/UpdateAddressRequest.md +1 -1
- data/docs/UpdateComponentValueAmendment.md +1 -1
- data/docs/UpdatePricingComponentValueChangeResult.md +1 -1
- data/docs/UpdatePricingComponentValueRequest.md +1 -1
- data/docs/UpdatePricingComponentValueResponse.md +1 -1
- data/docs/UpdatePricingComponentValueResponsePagedMetadata.md +1 -1
- data/docs/UpdateProfileRequest.md +1 -1
- data/docs/UpdateRoleRequest.md +1 -1
- data/docs/UpdateSubscriptionRequest.md +1 -1
- data/docs/Usage.md +1 -1
- data/docs/UsageApi.md +13 -13
- data/docs/UsagePagedMetadata.md +1 -1
- data/docs/UsagePeriodPagedMetadata.md +1 -1
- data/docs/UsageRoundingStrategyPagedMetadata.md +1 -1
- data/docs/UsageSession.md +1 -1
- data/docs/UsageSessionPagedMetadata.md +1 -1
- data/docs/UsageperiodsApi.md +7 -7
- data/docs/UsageroundingstrategiesApi.md +11 -11
- data/docs/UsagesessionsApi.md +11 -11
- data/docs/User.md +1 -1
- data/docs/UserCreationRequest.md +1 -1
- data/docs/UserCreationResponsePagedMetadata.md +1 -1
- data/docs/UserPagedMetadata.md +1 -1
- data/docs/Username.md +1 -1
- data/docs/UsernamePagedMetadata.md +1 -1
- data/docs/UsernamesApi.md +4 -4
- data/docs/UsersApi.md +28 -28
- data/docs/VaultedgatewaysApi.md +36 -36
- data/docs/WebhookPagedMetadata.md +1 -1
- data/docs/WebhooksApi.md +18 -18
- data/lib/bf_ruby2/api/accounts_api.rb +1 -1
- data/lib/bf_ruby2/api/addresses_api.rb +1 -1
- data/lib/bf_ruby2/api/amendments_api.rb +1 -1
- data/lib/bf_ruby2/api/analytics_api.rb +1 -1
- data/lib/bf_ruby2/api/auditlogs_api.rb +1 -1
- data/lib/bf_ruby2/api/charges_api.rb +1 -1
- data/lib/bf_ruby2/api/clients_api.rb +1 -1
- data/lib/bf_ruby2/api/configurations_api.rb +1 -1
- data/lib/bf_ruby2/api/couponbook_api.rb +1 -1
- data/lib/bf_ruby2/api/couponbookdefinition_api.rb +1 -1
- data/lib/bf_ruby2/api/coupondefinition_api.rb +1 -1
- data/lib/bf_ruby2/api/couponinstance_api.rb +1 -1
- data/lib/bf_ruby2/api/couponmodifier_api.rb +1 -1
- data/lib/bf_ruby2/api/couponrule_api.rb +1 -1
- data/lib/bf_ruby2/api/coupons_api.rb +1 -1
- data/lib/bf_ruby2/api/creditnotes_api.rb +1 -1
- data/lib/bf_ruby2/api/cybersourcetokens_api.rb +1 -1
- data/lib/bf_ruby2/api/dunninglines_api.rb +1 -1
- data/lib/bf_ruby2/api/emailproviders_api.rb +1 -1
- data/lib/bf_ruby2/api/emails_api.rb +1 -1
- data/lib/bf_ruby2/api/emailsubscriptions_api.rb +1 -1
- data/lib/bf_ruby2/api/fixedtermdefinitions_api.rb +1 -1
- data/lib/bf_ruby2/api/fixedterms_api.rb +1 -1
- data/lib/bf_ruby2/api/invoices_api.rb +1 -1
- data/lib/bf_ruby2/api/metadata_api.rb +1 -1
- data/lib/bf_ruby2/api/notifications_api.rb +1 -1
- data/lib/bf_ruby2/api/organizations_api.rb +1 -1
- data/lib/bf_ruby2/api/passwords_api.rb +1 -1
- data/lib/bf_ruby2/api/paymentmethods_api.rb +1 -1
- data/lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb +1 -1
- data/lib/bf_ruby2/api/payments_api.rb +1 -1
- data/lib/bf_ruby2/api/periods_api.rb +1 -1
- data/lib/bf_ruby2/api/permissions_api.rb +1 -1
- data/lib/bf_ruby2/api/pricingcalculator_api.rb +1 -1
- data/lib/bf_ruby2/api/pricingcomponents_api.rb +1 -1
- data/lib/bf_ruby2/api/pricingcomponenttiers_api.rb +1 -1
- data/lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb +1 -1
- data/lib/bf_ruby2/api/pricingcomponentvalues_api.rb +1 -1
- data/lib/bf_ruby2/api/productrateplans_api.rb +1 -1
- data/lib/bf_ruby2/api/products_api.rb +1 -1
- data/lib/bf_ruby2/api/profiles_api.rb +1 -1
- data/lib/bf_ruby2/api/quotes_api.rb +1 -1
- data/lib/bf_ruby2/api/receipts_api.rb +1 -1
- data/lib/bf_ruby2/api/refunds_api.rb +1 -1
- data/lib/bf_ruby2/api/roles_api.rb +1 -1
- data/lib/bf_ruby2/api/search_api.rb +1 -1
- data/lib/bf_ruby2/api/subscriptions_api.rb +1 -1
- data/lib/bf_ruby2/api/synch_app_configs_api.rb +1 -1
- data/lib/bf_ruby2/api/synch_configs_api.rb +1 -1
- data/lib/bf_ruby2/api/synch_jobs_api.rb +1 -1
- data/lib/bf_ruby2/api/taxationlinks_api.rb +1 -1
- data/lib/bf_ruby2/api/taxationstrategies_api.rb +1 -1
- data/lib/bf_ruby2/api/time_api.rb +1 -1
- data/lib/bf_ruby2/api/tokenization_api.rb +5 -5
- data/lib/bf_ruby2/api/unitofmeasure_api.rb +1 -1
- data/lib/bf_ruby2/api/usage_api.rb +1 -1
- data/lib/bf_ruby2/api/usageperiods_api.rb +1 -1
- data/lib/bf_ruby2/api/usageroundingstrategies_api.rb +1 -1
- data/lib/bf_ruby2/api/usagesessions_api.rb +1 -1
- data/lib/bf_ruby2/api/usernames_api.rb +1 -1
- data/lib/bf_ruby2/api/users_api.rb +1 -1
- data/lib/bf_ruby2/api/vaultedgateways_api.rb +1 -1
- data/lib/bf_ruby2/api/webhooks_api.rb +1 -1
- data/lib/bf_ruby2/api_client.rb +2 -2
- data/lib/bf_ruby2/api_error.rb +1 -1
- data/lib/bf_ruby2/configuration.rb +1 -1
- data/lib/bf_ruby2/models/account.rb +2 -2
- data/lib/bf_ruby2/models/account_ltv_result_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/account_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/account_payments_result_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/add_charge_request.rb +2 -2
- data/lib/bf_ruby2/models/add_charge_to_account_response.rb +2 -2
- data/lib/bf_ruby2/models/add_charge_to_account_response_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/add_charges_to_account_api_request.rb +2 -2
- data/lib/bf_ruby2/models/add_coupon_code_request.rb +2 -2
- data/lib/bf_ruby2/models/add_payment_method_request.rb +2 -2
- data/lib/bf_ruby2/models/add_taxation_strategy_request.rb +2 -2
- data/lib/bf_ruby2/models/address.rb +2 -2
- data/lib/bf_ruby2/models/address_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/aggregating_component.rb +2 -2
- data/lib/bf_ruby2/models/amendment.rb +2 -2
- data/lib/bf_ruby2/models/amendment_discard_amendment.rb +2 -2
- data/lib/bf_ruby2/models/amendment_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/amendment_price_n_time_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/api_configuration_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/api_quote.rb +2 -2
- data/lib/bf_ruby2/models/api_quote_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/api_quote_response_quantity.rb +2 -2
- data/lib/bf_ruby2/models/audit_entry.rb +2 -2
- data/lib/bf_ruby2/models/audit_entry_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/auth_capture_request.rb +2 -2
- data/lib/bf_ruby2/models/authorize_net_token_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/bank_account_verification_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/batch_update_pricing_component_values_request.rb +2 -2
- data/lib/bf_ruby2/models/bf_error.rb +2 -2
- data/lib/bf_ruby2/models/bf_permission.rb +2 -2
- data/lib/bf_ruby2/models/bf_permission_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/billforward_managed_payments_result_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/billing_entity_base.rb +2 -2
- data/lib/bf_ruby2/models/braintree_auth_capture_request.rb +2 -2
- data/lib/bf_ruby2/models/braintree_capture_request.rb +2 -2
- data/lib/bf_ruby2/models/braintree_token_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/cancel_subscription_request.rb +2 -2
- data/lib/bf_ruby2/models/cancellation_amendment.rb +2 -2
- data/lib/bf_ruby2/models/cass_churn_result_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/cass_payment_result_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/cass_upgrade_result_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/client.rb +2 -2
- data/lib/bf_ruby2/models/client_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/component_change.rb +2 -2
- data/lib/bf_ruby2/models/component_cost.rb +2 -2
- data/lib/bf_ruby2/models/compound_usage.rb +2 -2
- data/lib/bf_ruby2/models/compound_usage_session.rb +2 -2
- data/lib/bf_ruby2/models/coupon.rb +2 -2
- data/lib/bf_ruby2/models/coupon_book.rb +2 -2
- data/lib/bf_ruby2/models/coupon_book_definition.rb +2 -2
- data/lib/bf_ruby2/models/coupon_book_definition_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/coupon_book_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/coupon_definition.rb +2 -2
- data/lib/bf_ruby2/models/coupon_definition_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/coupon_discount.rb +2 -2
- data/lib/bf_ruby2/models/coupon_discount_estimate.rb +2 -2
- data/lib/bf_ruby2/models/coupon_instance.rb +2 -2
- data/lib/bf_ruby2/models/coupon_instance_existing_value.rb +2 -2
- data/lib/bf_ruby2/models/coupon_instance_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/coupon_modifier_base.rb +2 -2
- data/lib/bf_ruby2/models/coupon_modifier_base_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/coupon_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/coupon_rule.rb +2 -2
- data/lib/bf_ruby2/models/coupon_rule_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/coupon_unique_codes_request.rb +2 -2
- data/lib/bf_ruby2/models/coupon_unique_codes_response.rb +2 -2
- data/lib/bf_ruby2/models/coupon_unique_codes_response_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/coupon_wrapper_response.rb +2 -2
- data/lib/bf_ruby2/models/create_account_profile_request.rb +2 -2
- data/lib/bf_ruby2/models/create_account_request.rb +2 -2
- data/lib/bf_ruby2/models/create_address_request.rb +2 -2
- data/lib/bf_ruby2/models/create_aggregating_component_request.rb +2 -2
- data/lib/bf_ruby2/models/create_aggregating_subscription_request.rb +2 -2
- data/lib/bf_ruby2/models/create_profile_address_request.rb +2 -2
- data/lib/bf_ruby2/models/create_subscription_batch_request.rb +2 -2
- data/lib/bf_ruby2/models/create_subscription_charge_amendment.rb +2 -2
- data/lib/bf_ruby2/models/create_subscription_request.rb +2 -2
- data/lib/bf_ruby2/models/credit_account_request.rb +2 -2
- data/lib/bf_ruby2/models/credit_note.rb +2 -2
- data/lib/bf_ruby2/models/credit_note_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/credit_subscription_request.rb +2 -2
- data/lib/bf_ruby2/models/cybersource_token_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/data_synchronisation_app_configuration_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/data_synchronisation_configuration.rb +2 -2
- data/lib/bf_ruby2/models/data_synchronisation_configuration_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/data_synchronization_job_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/debts_result_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/dunning_line.rb +2 -2
- data/lib/bf_ruby2/models/dunning_line_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/dynamic_metadata.rb +2 -2
- data/lib/bf_ruby2/models/email.rb +2 -2
- data/lib/bf_ruby2/models/email_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/email_provider.rb +2 -2
- data/lib/bf_ruby2/models/email_provider_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/email_subscription.rb +2 -2
- data/lib/bf_ruby2/models/email_subscription_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/end_trial_amendment.rb +2 -2
- data/lib/bf_ruby2/models/event.rb +2 -2
- data/lib/bf_ruby2/models/event_data.rb +2 -2
- data/lib/bf_ruby2/models/file_sham.rb +2 -2
- data/lib/bf_ruby2/models/fixed_term.rb +2 -2
- data/lib/bf_ruby2/models/fixed_term_definition_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/fixed_term_expiry_amendment.rb +2 -2
- data/lib/bf_ruby2/models/fixed_term_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/flat_pricing_component.rb +2 -2
- data/lib/bf_ruby2/models/import_invoice_line.rb +2 -2
- data/lib/bf_ruby2/models/insertable_billing_entity.rb +2 -2
- data/lib/bf_ruby2/models/invoice.rb +2 -2
- data/lib/bf_ruby2/models/invoice_charge_request.rb +2 -2
- data/lib/bf_ruby2/models/invoice_line.rb +2 -2
- data/lib/bf_ruby2/models/invoice_line_payment.rb +2 -2
- data/lib/bf_ruby2/models/invoice_line_payment_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/invoice_next_execution_attempt_amendment.rb +2 -2
- data/lib/bf_ruby2/models/invoice_outstanding_charges_amendment.rb +2 -2
- data/lib/bf_ruby2/models/invoice_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/invoice_payment.rb +2 -2
- data/lib/bf_ruby2/models/invoice_recalculation_amendment.rb +2 -2
- data/lib/bf_ruby2/models/invoice_recalculation_request.rb +2 -2
- data/lib/bf_ruby2/models/issue_invoice_amendment.rb +2 -2
- data/lib/bf_ruby2/models/metadata_key_values_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/migration_request.rb +2 -2
- data/lib/bf_ruby2/models/model_alias.rb +2 -2
- data/lib/bf_ruby2/models/mutable_billing_entity.rb +2 -2
- data/lib/bf_ruby2/models/nested_charge_request.rb +2 -2
- data/lib/bf_ruby2/models/notification.rb +2 -2
- data/lib/bf_ruby2/models/notification_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/organization.rb +2 -2
- data/lib/bf_ruby2/models/organization_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/password.rb +2 -2
- data/lib/bf_ruby2/models/password_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/password_reset_request.rb +2 -2
- data/lib/bf_ruby2/models/pause_request.rb +2 -2
- data/lib/bf_ruby2/models/payment.rb +2 -2
- data/lib/bf_ruby2/models/payment_method.rb +2 -2
- data/lib/bf_ruby2/models/payment_method_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/payment_method_subscription_link.rb +2 -2
- data/lib/bf_ruby2/models/payment_method_subscription_link_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/payment_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/payment_retry_request.rb +2 -2
- data/lib/bf_ruby2/models/pending_component_value_change.rb +2 -2
- data/lib/bf_ruby2/models/period.rb +2 -2
- data/lib/bf_ruby2/models/period_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/permission_action_entity_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/permission_resource_entity_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/price_calculation_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_coupon_modifier.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_migration_value.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_quantity_request.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_tier.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_tier_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_value.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_value_change_amendment.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_value_change_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_value_migration_amendment_mapping.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_value_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_value_request.rb +2 -2
- data/lib/bf_ruby2/models/pricing_component_value_response_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/product.rb +3 -3
- data/lib/bf_ruby2/models/product_coupon_modifier.rb +2 -2
- data/lib/bf_ruby2/models/product_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/product_payments_result_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/product_rate_plan.rb +3 -3
- data/lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb +2 -2
- data/lib/bf_ruby2/models/product_rate_plan_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/product_rate_plan_payments_result_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/profile.rb +2 -2
- data/lib/bf_ruby2/models/profile_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/quote_request.rb +2 -2
- data/lib/bf_ruby2/models/quote_request_value.rb +2 -2
- data/lib/bf_ruby2/models/recalculate_charge_batch_request.rb +2 -2
- data/lib/bf_ruby2/models/recalculate_charge_batch_response.rb +2 -2
- data/lib/bf_ruby2/models/recalculate_charge_batch_response_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/recalculate_charge_request.rb +2 -2
- data/lib/bf_ruby2/models/receipt.rb +2 -2
- data/lib/bf_ruby2/models/receipt_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/refund.rb +2 -2
- data/lib/bf_ruby2/models/refund_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/resume_request.rb +2 -2
- data/lib/bf_ruby2/models/resume_subscription_amendment.rb +2 -2
- data/lib/bf_ruby2/models/revenue_attribution.rb +2 -2
- data/lib/bf_ruby2/models/revenue_attribution_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/revive_subscription_request.rb +2 -2
- data/lib/bf_ruby2/models/role.rb +2 -2
- data/lib/bf_ruby2/models/role_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/rule_satisfaction.rb +2 -2
- data/lib/bf_ruby2/models/search_result_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/service_end_amendment.rb +2 -2
- data/lib/bf_ruby2/models/single_recalculate_charge_request.rb +2 -2
- data/lib/bf_ruby2/models/stripe_ach_token_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/stripe_auth_capture_request.rb +2 -2
- data/lib/bf_ruby2/models/stripe_object.rb +2 -2
- data/lib/bf_ruby2/models/stripe_token_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/subscription.rb +2 -2
- data/lib/bf_ruby2/models/subscription_cancellation_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/subscription_charge.rb +2 -2
- data/lib/bf_ruby2/models/subscription_charge_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/subscription_ltv_result_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/subscription_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/swagger_type_list.rb +2 -2
- data/lib/bf_ruby2/models/swagger_type_list_inv.rb +2 -2
- data/lib/bf_ruby2/models/swagger_type_list_subs.rb +2 -2
- data/lib/bf_ruby2/models/taxation_link_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/taxation_strategy_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/tiered_pricing_component.rb +2 -2
- data/lib/bf_ruby2/models/tiered_volume_pricing_component.rb +2 -2
- data/lib/bf_ruby2/models/time_request.rb +2 -2
- data/lib/bf_ruby2/models/time_response.rb +2 -2
- data/lib/bf_ruby2/models/time_response_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/time_zone.rb +2 -2
- data/lib/bf_ruby2/models/timer_amendment.rb +2 -2
- data/lib/bf_ruby2/models/tokenization_pre_auth_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/trust_commerce_token_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/unit_discount.rb +2 -2
- data/lib/bf_ruby2/models/unit_of_measure.rb +2 -2
- data/lib/bf_ruby2/models/unit_of_measure_coupon_modifier.rb +2 -2
- data/lib/bf_ruby2/models/unit_of_measure_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/update_address_request.rb +2 -2
- data/lib/bf_ruby2/models/update_component_value_amendment.rb +2 -2
- data/lib/bf_ruby2/models/update_pricing_component_value_change_result.rb +2 -2
- data/lib/bf_ruby2/models/update_pricing_component_value_request.rb +2 -2
- data/lib/bf_ruby2/models/update_pricing_component_value_response.rb +2 -2
- data/lib/bf_ruby2/models/update_pricing_component_value_response_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/update_profile_request.rb +2 -2
- data/lib/bf_ruby2/models/update_role_request.rb +2 -2
- data/lib/bf_ruby2/models/update_subscription_request.rb +2 -2
- data/lib/bf_ruby2/models/usage.rb +2 -2
- data/lib/bf_ruby2/models/usage_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/usage_period_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/usage_rounding_strategy_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/usage_session.rb +2 -2
- data/lib/bf_ruby2/models/usage_session_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/user.rb +2 -2
- data/lib/bf_ruby2/models/user_creation_request.rb +2 -2
- data/lib/bf_ruby2/models/user_creation_response_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/user_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/username.rb +2 -2
- data/lib/bf_ruby2/models/username_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/models/webhook_paged_metadata.rb +2 -2
- data/lib/bf_ruby2/version.rb +2 -2
- data/lib/bf_ruby2.rb +2 -2
- data/spec/api/accounts_api_spec.rb +3 -3
- data/spec/api/addresses_api_spec.rb +3 -3
- data/spec/api/amendments_api_spec.rb +3 -3
- data/spec/api/analytics_api_spec.rb +3 -3
- data/spec/api/auditlogs_api_spec.rb +3 -3
- data/spec/api/charges_api_spec.rb +3 -3
- data/spec/api/clients_api_spec.rb +3 -3
- data/spec/api/configurations_api_spec.rb +3 -3
- data/spec/api/couponbook_api_spec.rb +3 -3
- data/spec/api/couponbookdefinition_api_spec.rb +3 -3
- data/spec/api/coupondefinition_api_spec.rb +3 -3
- data/spec/api/couponinstance_api_spec.rb +3 -3
- data/spec/api/couponmodifier_api_spec.rb +3 -3
- data/spec/api/couponrule_api_spec.rb +3 -3
- data/spec/api/coupons_api_spec.rb +3 -3
- data/spec/api/creditnotes_api_spec.rb +3 -3
- data/spec/api/cybersourcetokens_api_spec.rb +3 -3
- data/spec/api/dunninglines_api_spec.rb +3 -3
- data/spec/api/emailproviders_api_spec.rb +3 -3
- data/spec/api/emails_api_spec.rb +3 -3
- data/spec/api/emailsubscriptions_api_spec.rb +3 -3
- data/spec/api/fixedtermdefinitions_api_spec.rb +3 -3
- data/spec/api/fixedterms_api_spec.rb +3 -3
- data/spec/api/invoices_api_spec.rb +3 -3
- data/spec/api/metadata_api_spec.rb +3 -3
- data/spec/api/notifications_api_spec.rb +3 -3
- data/spec/api/organizations_api_spec.rb +3 -3
- data/spec/api/passwords_api_spec.rb +3 -3
- data/spec/api/paymentmethods_api_spec.rb +3 -3
- data/spec/api/paymentmethodsubscriptionlinks_api_spec.rb +3 -3
- data/spec/api/payments_api_spec.rb +3 -3
- data/spec/api/periods_api_spec.rb +3 -3
- data/spec/api/permissions_api_spec.rb +3 -3
- data/spec/api/pricingcalculator_api_spec.rb +3 -3
- data/spec/api/pricingcomponents_api_spec.rb +3 -3
- data/spec/api/pricingcomponenttiers_api_spec.rb +3 -3
- data/spec/api/pricingcomponentvaluechanges_api_spec.rb +3 -3
- data/spec/api/pricingcomponentvalues_api_spec.rb +3 -3
- data/spec/api/productrateplans_api_spec.rb +3 -3
- data/spec/api/products_api_spec.rb +3 -3
- data/spec/api/profiles_api_spec.rb +3 -3
- data/spec/api/quotes_api_spec.rb +3 -3
- data/spec/api/receipts_api_spec.rb +3 -3
- data/spec/api/refunds_api_spec.rb +3 -3
- data/spec/api/roles_api_spec.rb +3 -3
- data/spec/api/search_api_spec.rb +3 -3
- data/spec/api/subscriptions_api_spec.rb +3 -3
- data/spec/api/synch_app_configs_api_spec.rb +3 -3
- data/spec/api/synch_configs_api_spec.rb +3 -3
- data/spec/api/synch_jobs_api_spec.rb +3 -3
- data/spec/api/taxationlinks_api_spec.rb +3 -3
- data/spec/api/taxationstrategies_api_spec.rb +3 -3
- data/spec/api/time_api_spec.rb +3 -3
- data/spec/api/tokenization_api_spec.rb +5 -5
- data/spec/api/unitofmeasure_api_spec.rb +3 -3
- data/spec/api/usage_api_spec.rb +3 -3
- data/spec/api/usageperiods_api_spec.rb +3 -3
- data/spec/api/usageroundingstrategies_api_spec.rb +3 -3
- data/spec/api/usagesessions_api_spec.rb +3 -3
- data/spec/api/usernames_api_spec.rb +3 -3
- data/spec/api/users_api_spec.rb +3 -3
- data/spec/api/vaultedgateways_api_spec.rb +3 -3
- data/spec/api/webhooks_api_spec.rb +3 -3
- data/spec/api_client_spec.rb +29 -29
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/account_ltv_result_paged_metadata_spec.rb +3 -3
- data/spec/models/account_paged_metadata_spec.rb +3 -3
- data/spec/models/account_payments_result_paged_metadata_spec.rb +3 -3
- data/spec/models/account_spec.rb +3 -3
- data/spec/models/add_charge_request_spec.rb +3 -3
- data/spec/models/add_charge_to_account_response_paged_metadata_spec.rb +3 -3
- data/spec/models/add_charge_to_account_response_spec.rb +3 -3
- data/spec/models/add_charges_to_account_api_request_spec.rb +3 -3
- data/spec/models/add_coupon_code_request_spec.rb +3 -3
- data/spec/models/add_payment_method_request_spec.rb +3 -3
- data/spec/models/add_taxation_strategy_request_spec.rb +3 -3
- data/spec/models/address_paged_metadata_spec.rb +3 -3
- data/spec/models/address_spec.rb +3 -3
- data/spec/models/aggregating_component_spec.rb +3 -3
- data/spec/models/amendment_discard_amendment_spec.rb +3 -3
- data/spec/models/amendment_paged_metadata_spec.rb +3 -3
- data/spec/models/amendment_price_n_time_paged_metadata_spec.rb +3 -3
- data/spec/models/amendment_spec.rb +3 -3
- data/spec/models/api_configuration_paged_metadata_spec.rb +3 -3
- data/spec/models/api_quote_paged_metadata_spec.rb +3 -3
- data/spec/models/api_quote_response_quantity_spec.rb +3 -3
- data/spec/models/api_quote_spec.rb +3 -3
- data/spec/models/audit_entry_paged_metadata_spec.rb +3 -3
- data/spec/models/audit_entry_spec.rb +3 -3
- data/spec/models/auth_capture_request_spec.rb +3 -3
- data/spec/models/authorize_net_token_paged_metadata_spec.rb +3 -3
- data/spec/models/bank_account_verification_paged_metadata_spec.rb +3 -3
- data/spec/models/batch_update_pricing_component_values_request_spec.rb +3 -3
- data/spec/models/bf_error_spec.rb +3 -3
- data/spec/models/bf_permission_paged_metadata_spec.rb +3 -3
- data/spec/models/bf_permission_spec.rb +3 -3
- data/spec/models/billforward_managed_payments_result_paged_metadata_spec.rb +3 -3
- data/spec/models/billing_entity_base_spec.rb +3 -3
- data/spec/models/braintree_auth_capture_request_spec.rb +3 -3
- data/spec/models/braintree_capture_request_spec.rb +3 -3
- data/spec/models/braintree_token_paged_metadata_spec.rb +3 -3
- data/spec/models/cancel_subscription_request_spec.rb +3 -3
- data/spec/models/cancellation_amendment_spec.rb +3 -3
- data/spec/models/cass_churn_result_paged_metadata_spec.rb +3 -3
- data/spec/models/cass_payment_result_paged_metadata_spec.rb +3 -3
- data/spec/models/cass_upgrade_result_paged_metadata_spec.rb +3 -3
- data/spec/models/client_paged_metadata_spec.rb +3 -3
- data/spec/models/client_spec.rb +3 -3
- data/spec/models/component_change_spec.rb +3 -3
- data/spec/models/component_cost_spec.rb +3 -3
- data/spec/models/compound_usage_session_spec.rb +3 -3
- data/spec/models/compound_usage_spec.rb +3 -3
- data/spec/models/coupon_book_definition_paged_metadata_spec.rb +3 -3
- data/spec/models/coupon_book_definition_spec.rb +3 -3
- data/spec/models/coupon_book_paged_metadata_spec.rb +3 -3
- data/spec/models/coupon_book_spec.rb +3 -3
- data/spec/models/coupon_definition_paged_metadata_spec.rb +3 -3
- data/spec/models/coupon_definition_spec.rb +3 -3
- data/spec/models/coupon_discount_estimate_spec.rb +3 -3
- data/spec/models/coupon_discount_spec.rb +3 -3
- data/spec/models/coupon_instance_existing_value_spec.rb +3 -3
- data/spec/models/coupon_instance_paged_metadata_spec.rb +3 -3
- data/spec/models/coupon_instance_spec.rb +3 -3
- data/spec/models/coupon_modifier_base_paged_metadata_spec.rb +3 -3
- data/spec/models/coupon_modifier_base_spec.rb +3 -3
- data/spec/models/coupon_paged_metadata_spec.rb +3 -3
- data/spec/models/coupon_rule_paged_metadata_spec.rb +3 -3
- data/spec/models/coupon_rule_spec.rb +3 -3
- data/spec/models/coupon_spec.rb +3 -3
- data/spec/models/coupon_unique_codes_request_spec.rb +3 -3
- data/spec/models/coupon_unique_codes_response_paged_metadata_spec.rb +3 -3
- data/spec/models/coupon_unique_codes_response_spec.rb +3 -3
- data/spec/models/coupon_wrapper_response_spec.rb +3 -3
- data/spec/models/create_account_profile_request_spec.rb +3 -3
- data/spec/models/create_account_request_spec.rb +3 -3
- data/spec/models/create_address_request_spec.rb +3 -3
- data/spec/models/create_aggregating_component_request_spec.rb +3 -3
- data/spec/models/create_aggregating_subscription_request_spec.rb +3 -3
- data/spec/models/create_profile_address_request_spec.rb +3 -3
- data/spec/models/create_subscription_batch_request_spec.rb +3 -3
- data/spec/models/create_subscription_charge_amendment_spec.rb +3 -3
- data/spec/models/create_subscription_request_spec.rb +3 -3
- data/spec/models/credit_account_request_spec.rb +3 -3
- data/spec/models/credit_note_paged_metadata_spec.rb +3 -3
- data/spec/models/credit_note_spec.rb +3 -3
- data/spec/models/credit_subscription_request_spec.rb +3 -3
- data/spec/models/cybersource_token_paged_metadata_spec.rb +3 -3
- data/spec/models/data_synchronisation_app_configuration_paged_metadata_spec.rb +3 -3
- data/spec/models/data_synchronisation_configuration_paged_metadata_spec.rb +3 -3
- data/spec/models/data_synchronisation_configuration_spec.rb +3 -3
- data/spec/models/data_synchronization_job_paged_metadata_spec.rb +3 -3
- data/spec/models/debts_result_paged_metadata_spec.rb +3 -3
- data/spec/models/dunning_line_paged_metadata_spec.rb +3 -3
- data/spec/models/dunning_line_spec.rb +3 -3
- data/spec/models/dynamic_metadata_spec.rb +3 -3
- data/spec/models/email_paged_metadata_spec.rb +3 -3
- data/spec/models/email_provider_paged_metadata_spec.rb +3 -3
- data/spec/models/email_provider_spec.rb +3 -3
- data/spec/models/email_spec.rb +3 -3
- data/spec/models/email_subscription_paged_metadata_spec.rb +3 -3
- data/spec/models/email_subscription_spec.rb +3 -3
- data/spec/models/end_trial_amendment_spec.rb +3 -3
- data/spec/models/event_data_spec.rb +3 -3
- data/spec/models/event_spec.rb +3 -3
- data/spec/models/file_sham_spec.rb +3 -3
- data/spec/models/fixed_term_definition_paged_metadata_spec.rb +3 -3
- data/spec/models/fixed_term_expiry_amendment_spec.rb +3 -3
- data/spec/models/fixed_term_paged_metadata_spec.rb +3 -3
- data/spec/models/fixed_term_spec.rb +3 -3
- data/spec/models/flat_pricing_component_spec.rb +3 -3
- data/spec/models/import_invoice_line_spec.rb +3 -3
- data/spec/models/insertable_billing_entity_spec.rb +3 -3
- data/spec/models/invoice_charge_request_spec.rb +3 -3
- data/spec/models/invoice_line_payment_paged_metadata_spec.rb +3 -3
- data/spec/models/invoice_line_payment_spec.rb +3 -3
- data/spec/models/invoice_line_spec.rb +3 -3
- data/spec/models/invoice_next_execution_attempt_amendment_spec.rb +3 -3
- data/spec/models/invoice_outstanding_charges_amendment_spec.rb +3 -3
- data/spec/models/invoice_paged_metadata_spec.rb +3 -3
- data/spec/models/invoice_payment_spec.rb +3 -3
- data/spec/models/invoice_recalculation_amendment_spec.rb +3 -3
- data/spec/models/invoice_recalculation_request_spec.rb +3 -3
- data/spec/models/invoice_spec.rb +3 -3
- data/spec/models/issue_invoice_amendment_spec.rb +3 -3
- data/spec/models/metadata_key_values_paged_metadata_spec.rb +3 -3
- data/spec/models/migration_request_spec.rb +3 -3
- data/spec/models/model_alias_spec.rb +3 -3
- data/spec/models/mutable_billing_entity_spec.rb +3 -3
- data/spec/models/nested_charge_request_spec.rb +3 -3
- data/spec/models/notification_paged_metadata_spec.rb +3 -3
- data/spec/models/notification_spec.rb +3 -3
- data/spec/models/organization_paged_metadata_spec.rb +3 -3
- data/spec/models/organization_spec.rb +3 -3
- data/spec/models/password_paged_metadata_spec.rb +3 -3
- data/spec/models/password_reset_request_spec.rb +3 -3
- data/spec/models/password_spec.rb +3 -3
- data/spec/models/pause_request_spec.rb +3 -3
- data/spec/models/payment_method_paged_metadata_spec.rb +3 -3
- data/spec/models/payment_method_spec.rb +3 -3
- data/spec/models/payment_method_subscription_link_paged_metadata_spec.rb +3 -3
- data/spec/models/payment_method_subscription_link_spec.rb +3 -3
- data/spec/models/payment_paged_metadata_spec.rb +3 -3
- data/spec/models/payment_retry_request_spec.rb +3 -3
- data/spec/models/payment_spec.rb +3 -3
- data/spec/models/pending_component_value_change_spec.rb +3 -3
- data/spec/models/period_paged_metadata_spec.rb +3 -3
- data/spec/models/period_spec.rb +3 -3
- data/spec/models/permission_action_entity_paged_metadata_spec.rb +3 -3
- data/spec/models/permission_resource_entity_paged_metadata_spec.rb +3 -3
- data/spec/models/price_calculation_paged_metadata_spec.rb +3 -3
- data/spec/models/pricing_component_coupon_modifier_spec.rb +3 -3
- data/spec/models/pricing_component_migration_value_spec.rb +3 -3
- data/spec/models/pricing_component_paged_metadata_spec.rb +3 -3
- data/spec/models/pricing_component_quantity_request_spec.rb +3 -3
- data/spec/models/pricing_component_spec.rb +3 -3
- data/spec/models/pricing_component_tier_paged_metadata_spec.rb +3 -3
- data/spec/models/pricing_component_tier_spec.rb +3 -3
- data/spec/models/pricing_component_value_change_amendment_spec.rb +3 -3
- data/spec/models/pricing_component_value_change_paged_metadata_spec.rb +3 -3
- data/spec/models/pricing_component_value_migration_amendment_mapping_spec.rb +3 -3
- data/spec/models/pricing_component_value_paged_metadata_spec.rb +3 -3
- data/spec/models/pricing_component_value_request_spec.rb +3 -3
- data/spec/models/pricing_component_value_response_paged_metadata_spec.rb +3 -3
- data/spec/models/pricing_component_value_spec.rb +3 -3
- data/spec/models/product_coupon_modifier_spec.rb +3 -3
- data/spec/models/product_paged_metadata_spec.rb +3 -3
- data/spec/models/product_payments_result_paged_metadata_spec.rb +3 -3
- data/spec/models/product_rate_plan_migration_amendment_spec.rb +3 -3
- data/spec/models/product_rate_plan_paged_metadata_spec.rb +3 -3
- data/spec/models/product_rate_plan_payments_result_paged_metadata_spec.rb +3 -3
- data/spec/models/product_rate_plan_spec.rb +3 -3
- data/spec/models/product_spec.rb +3 -3
- data/spec/models/profile_paged_metadata_spec.rb +3 -3
- data/spec/models/profile_spec.rb +3 -3
- data/spec/models/quote_request_spec.rb +3 -3
- data/spec/models/quote_request_value_spec.rb +3 -3
- data/spec/models/recalculate_charge_batch_request_spec.rb +3 -3
- data/spec/models/recalculate_charge_batch_response_paged_metadata_spec.rb +3 -3
- data/spec/models/recalculate_charge_batch_response_spec.rb +3 -3
- data/spec/models/recalculate_charge_request_spec.rb +3 -3
- data/spec/models/receipt_paged_metadata_spec.rb +3 -3
- data/spec/models/receipt_spec.rb +3 -3
- data/spec/models/refund_paged_metadata_spec.rb +3 -3
- data/spec/models/refund_spec.rb +3 -3
- data/spec/models/resume_request_spec.rb +3 -3
- data/spec/models/resume_subscription_amendment_spec.rb +3 -3
- data/spec/models/revenue_attribution_paged_metadata_spec.rb +3 -3
- data/spec/models/revenue_attribution_spec.rb +3 -3
- data/spec/models/revive_subscription_request_spec.rb +3 -3
- data/spec/models/role_paged_metadata_spec.rb +3 -3
- data/spec/models/role_spec.rb +3 -3
- data/spec/models/rule_satisfaction_spec.rb +3 -3
- data/spec/models/search_result_paged_metadata_spec.rb +3 -3
- data/spec/models/service_end_amendment_spec.rb +3 -3
- data/spec/models/single_recalculate_charge_request_spec.rb +3 -3
- data/spec/models/stripe_ach_token_paged_metadata_spec.rb +3 -3
- data/spec/models/stripe_auth_capture_request_spec.rb +3 -3
- data/spec/models/stripe_object_spec.rb +3 -3
- data/spec/models/stripe_token_paged_metadata_spec.rb +3 -3
- data/spec/models/subscription_cancellation_paged_metadata_spec.rb +3 -3
- data/spec/models/subscription_charge_paged_metadata_spec.rb +3 -3
- data/spec/models/subscription_charge_spec.rb +3 -3
- data/spec/models/subscription_ltv_result_paged_metadata_spec.rb +3 -3
- data/spec/models/subscription_paged_metadata_spec.rb +3 -3
- data/spec/models/subscription_spec.rb +3 -3
- data/spec/models/swagger_type_list_inv_spec.rb +3 -3
- data/spec/models/swagger_type_list_spec.rb +3 -3
- data/spec/models/swagger_type_list_subs_spec.rb +3 -3
- data/spec/models/taxation_link_paged_metadata_spec.rb +3 -3
- data/spec/models/taxation_strategy_paged_metadata_spec.rb +3 -3
- data/spec/models/tiered_pricing_component_spec.rb +3 -3
- data/spec/models/tiered_volume_pricing_component_spec.rb +3 -3
- data/spec/models/time_request_spec.rb +3 -3
- data/spec/models/time_response_paged_metadata_spec.rb +3 -3
- data/spec/models/time_response_spec.rb +3 -3
- data/spec/models/time_zone_spec.rb +3 -3
- data/spec/models/timer_amendment_spec.rb +3 -3
- data/spec/models/tokenization_pre_auth_paged_metadata_spec.rb +3 -3
- data/spec/models/trust_commerce_token_paged_metadata_spec.rb +3 -3
- data/spec/models/unit_discount_spec.rb +3 -3
- data/spec/models/unit_of_measure_coupon_modifier_spec.rb +3 -3
- data/spec/models/unit_of_measure_paged_metadata_spec.rb +3 -3
- data/spec/models/unit_of_measure_spec.rb +3 -3
- data/spec/models/update_address_request_spec.rb +3 -3
- data/spec/models/update_component_value_amendment_spec.rb +3 -3
- data/spec/models/update_pricing_component_value_change_result_spec.rb +3 -3
- data/spec/models/update_pricing_component_value_request_spec.rb +3 -3
- data/spec/models/update_pricing_component_value_response_paged_metadata_spec.rb +3 -3
- data/spec/models/update_pricing_component_value_response_spec.rb +3 -3
- data/spec/models/update_profile_request_spec.rb +3 -3
- data/spec/models/update_role_request_spec.rb +3 -3
- data/spec/models/update_subscription_request_spec.rb +3 -3
- data/spec/models/usage_paged_metadata_spec.rb +3 -3
- data/spec/models/usage_period_paged_metadata_spec.rb +3 -3
- data/spec/models/usage_rounding_strategy_paged_metadata_spec.rb +3 -3
- data/spec/models/usage_session_paged_metadata_spec.rb +3 -3
- data/spec/models/usage_session_spec.rb +3 -3
- data/spec/models/usage_spec.rb +3 -3
- data/spec/models/user_creation_request_spec.rb +3 -3
- data/spec/models/user_creation_response_paged_metadata_spec.rb +3 -3
- data/spec/models/user_paged_metadata_spec.rb +3 -3
- data/spec/models/user_spec.rb +3 -3
- data/spec/models/username_paged_metadata_spec.rb +3 -3
- data/spec/models/username_spec.rb +3 -3
- data/spec/models/webhook_paged_metadata_spec.rb +3 -3
- metadata +4 -2
data/docs/SubscriptionsApi.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# Bfwd::SubscriptionsApi
|
2
2
|
|
3
3
|
All URIs are relative to *https://localhost:8080/RestAPI*
|
4
4
|
|
@@ -70,18 +70,18 @@ Creates a charge on the specified subscription.
|
|
70
70
|
# load the gem
|
71
71
|
require 'bf_ruby2'
|
72
72
|
|
73
|
-
api_instance =
|
73
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
74
74
|
|
75
75
|
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
76
76
|
|
77
|
-
charge =
|
77
|
+
charge = Bfwd::AddChargeRequest.new # AddChargeRequest | The charge request
|
78
78
|
|
79
79
|
|
80
80
|
begin
|
81
81
|
#Creates a charge on the specified subscription.
|
82
82
|
result = api_instance.add_charge_to_subscription(subscription_id, charge)
|
83
83
|
p result
|
84
|
-
rescue
|
84
|
+
rescue Bfwd::ApiError => e
|
85
85
|
puts "Exception when calling SubscriptionsApi->add_charge_to_subscription: #{e}"
|
86
86
|
end
|
87
87
|
```
|
@@ -120,18 +120,18 @@ Applies a coupon to a subscription.
|
|
120
120
|
# load the gem
|
121
121
|
require 'bf_ruby2'
|
122
122
|
|
123
|
-
api_instance =
|
123
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
124
124
|
|
125
125
|
subscription_id = "subscription_id_example" # String |
|
126
126
|
|
127
|
-
request =
|
127
|
+
request = Bfwd::AddCouponCodeRequest.new # AddCouponCodeRequest | Request containing the coupon code.
|
128
128
|
|
129
129
|
|
130
130
|
begin
|
131
131
|
#Applies a coupon to a subscription.
|
132
132
|
result = api_instance.add_coupon_to_subscription(subscription_id, request)
|
133
133
|
p result
|
134
|
-
rescue
|
134
|
+
rescue Bfwd::ApiError => e
|
135
135
|
puts "Exception when calling SubscriptionsApi->add_coupon_to_subscription: #{e}"
|
136
136
|
end
|
137
137
|
```
|
@@ -170,18 +170,18 @@ Creates a credit-note which may be used by only the specified subscription.
|
|
170
170
|
# load the gem
|
171
171
|
require 'bf_ruby2'
|
172
172
|
|
173
|
-
api_instance =
|
173
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
174
174
|
|
175
175
|
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
176
176
|
|
177
|
-
credit_note =
|
177
|
+
credit_note = Bfwd::CreditSubscriptionRequest.new # CreditSubscriptionRequest | The credit-note request
|
178
178
|
|
179
179
|
|
180
180
|
begin
|
181
181
|
#Creates a credit-note which may be used by only the specified subscription.
|
182
182
|
result = api_instance.add_credit_note_to_subscription(subscription_id, credit_note)
|
183
183
|
p result
|
184
|
-
rescue
|
184
|
+
rescue Bfwd::ApiError => e
|
185
185
|
puts "Exception when calling SubscriptionsApi->add_credit_note_to_subscription: #{e}"
|
186
186
|
end
|
187
187
|
```
|
@@ -220,18 +220,18 @@ Enables the payment method to pay invoices of this subscription.
|
|
220
220
|
# load the gem
|
221
221
|
require 'bf_ruby2'
|
222
222
|
|
223
|
-
api_instance =
|
223
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
224
224
|
|
225
225
|
subscription_id = "subscription_id_example" # String |
|
226
226
|
|
227
|
-
payment_method =
|
227
|
+
payment_method = Bfwd::AddPaymentMethodRequest.new # AddPaymentMethodRequest |
|
228
228
|
|
229
229
|
|
230
230
|
begin
|
231
231
|
#Enables the payment method to pay invoices of this subscription.
|
232
232
|
result = api_instance.add_payment_method_to_subscription(subscription_id, payment_method)
|
233
233
|
p result
|
234
|
-
rescue
|
234
|
+
rescue Bfwd::ApiError => e
|
235
235
|
puts "Exception when calling SubscriptionsApi->add_payment_method_to_subscription: #{e}"
|
236
236
|
end
|
237
237
|
```
|
@@ -270,18 +270,18 @@ Advance the subscription through time.
|
|
270
270
|
# load the gem
|
271
271
|
require 'bf_ruby2'
|
272
272
|
|
273
|
-
api_instance =
|
273
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
274
274
|
|
275
275
|
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
276
276
|
|
277
|
-
request =
|
277
|
+
request = Bfwd::TimeRequest.new # TimeRequest | The request
|
278
278
|
|
279
279
|
|
280
280
|
begin
|
281
281
|
#Advance the subscription through time.
|
282
282
|
result = api_instance.advance_subscription(subscription_id, request)
|
283
283
|
p result
|
284
|
-
rescue
|
284
|
+
rescue Bfwd::ApiError => e
|
285
285
|
puts "Exception when calling SubscriptionsApi->advance_subscription: #{e}"
|
286
286
|
end
|
287
287
|
```
|
@@ -320,7 +320,7 @@ Returns all available payment methods for the specified subscription. By default
|
|
320
320
|
# load the gem
|
321
321
|
require 'bf_ruby2'
|
322
322
|
|
323
|
-
api_instance =
|
323
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
324
324
|
|
325
325
|
subscription_id = "subscription_id_example" # String |
|
326
326
|
|
@@ -336,7 +336,7 @@ begin
|
|
336
336
|
#Returns all available payment methods for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
337
337
|
result = api_instance.available_payment_methods_for_subscription(subscription_id, opts)
|
338
338
|
p result
|
339
|
-
rescue
|
339
|
+
rescue Bfwd::ApiError => e
|
340
340
|
puts "Exception when calling SubscriptionsApi->available_payment_methods_for_subscription: #{e}"
|
341
341
|
end
|
342
342
|
```
|
@@ -379,16 +379,16 @@ Create multiple subscriptions.
|
|
379
379
|
# load the gem
|
380
380
|
require 'bf_ruby2'
|
381
381
|
|
382
|
-
api_instance =
|
382
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
383
383
|
|
384
|
-
request =
|
384
|
+
request = Bfwd::CreateSubscriptionBatchRequest.new # CreateSubscriptionBatchRequest |
|
385
385
|
|
386
386
|
|
387
387
|
begin
|
388
388
|
#Create multiple subscriptions.
|
389
389
|
result = api_instance.batch_create_subscriptions(request)
|
390
390
|
p result
|
391
|
-
rescue
|
391
|
+
rescue Bfwd::ApiError => e
|
392
392
|
puts "Exception when calling SubscriptionsApi->batch_create_subscriptions: #{e}"
|
393
393
|
end
|
394
394
|
```
|
@@ -426,18 +426,18 @@ Retires the subscription specified by the subscription-ID parameter. Retiring a
|
|
426
426
|
# load the gem
|
427
427
|
require 'bf_ruby2'
|
428
428
|
|
429
|
-
api_instance =
|
429
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
430
430
|
|
431
431
|
subscription_id = "subscription_id_example" # String |
|
432
432
|
|
433
|
-
subscription_cancellation =
|
433
|
+
subscription_cancellation = Bfwd::CancelSubscriptionRequest.new # CancelSubscriptionRequest | The cancellation request
|
434
434
|
|
435
435
|
|
436
436
|
begin
|
437
437
|
#Retires the subscription specified by the subscription-ID parameter. Retiring a subscription causes it to cancel based on the specified retirement settings for the product.
|
438
438
|
result = api_instance.cancel_subscription(subscription_id, subscription_cancellation)
|
439
439
|
p result
|
440
|
-
rescue
|
440
|
+
rescue Bfwd::ApiError => e
|
441
441
|
puts "Exception when calling SubscriptionsApi->cancel_subscription: #{e}"
|
442
442
|
end
|
443
443
|
```
|
@@ -476,16 +476,16 @@ Create an aggregating subscription.
|
|
476
476
|
# load the gem
|
477
477
|
require 'bf_ruby2'
|
478
478
|
|
479
|
-
api_instance =
|
479
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
480
480
|
|
481
|
-
request =
|
481
|
+
request = Bfwd::CreateAggregatingSubscriptionRequest.new # CreateAggregatingSubscriptionRequest |
|
482
482
|
|
483
483
|
|
484
484
|
begin
|
485
485
|
#Create an aggregating subscription.
|
486
486
|
result = api_instance.create_aggregating_subscription(request)
|
487
487
|
p result
|
488
|
-
rescue
|
488
|
+
rescue Bfwd::ApiError => e
|
489
489
|
puts "Exception when calling SubscriptionsApi->create_aggregating_subscription: #{e}"
|
490
490
|
end
|
491
491
|
```
|
@@ -523,16 +523,16 @@ Create a new subscription.
|
|
523
523
|
# load the gem
|
524
524
|
require 'bf_ruby2'
|
525
525
|
|
526
|
-
api_instance =
|
526
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
527
527
|
|
528
|
-
subscription =
|
528
|
+
subscription = Bfwd::Subscription.new # Subscription | The subscription object to be updated.
|
529
529
|
|
530
530
|
|
531
531
|
begin
|
532
532
|
#Create a new subscription.
|
533
533
|
result = api_instance.create_subscription(subscription)
|
534
534
|
p result
|
535
|
-
rescue
|
535
|
+
rescue Bfwd::ApiError => e
|
536
536
|
puts "Exception when calling SubscriptionsApi->create_subscription: #{e}"
|
537
537
|
end
|
538
538
|
```
|
@@ -570,16 +570,16 @@ Create a subscription (V2).
|
|
570
570
|
# load the gem
|
571
571
|
require 'bf_ruby2'
|
572
572
|
|
573
|
-
api_instance =
|
573
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
574
574
|
|
575
|
-
request =
|
575
|
+
request = Bfwd::CreateSubscriptionRequest.new # CreateSubscriptionRequest |
|
576
576
|
|
577
577
|
|
578
578
|
begin
|
579
579
|
#Create a subscription (V2).
|
580
580
|
result = api_instance.create_subscription_v2(request)
|
581
581
|
p result
|
582
|
-
rescue
|
582
|
+
rescue Bfwd::ApiError => e
|
583
583
|
puts "Exception when calling SubscriptionsApi->create_subscription_v2: #{e}"
|
584
584
|
end
|
585
585
|
```
|
@@ -617,18 +617,18 @@ Create a timer for a subscription event.
|
|
617
617
|
# load the gem
|
618
618
|
require 'bf_ruby2'
|
619
619
|
|
620
|
-
api_instance =
|
620
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
621
621
|
|
622
622
|
subscription_id = "subscription_id_example" # String |
|
623
623
|
|
624
|
-
request =
|
624
|
+
request = Bfwd::BillingEntityBase.new # BillingEntityBase |
|
625
625
|
|
626
626
|
|
627
627
|
begin
|
628
628
|
#Create a timer for a subscription event.
|
629
629
|
result = api_instance.create_timer(subscription_id, request)
|
630
630
|
p result
|
631
|
-
rescue
|
631
|
+
rescue Bfwd::ApiError => e
|
632
632
|
puts "Exception when calling SubscriptionsApi->create_timer: #{e}"
|
633
633
|
end
|
634
634
|
```
|
@@ -667,7 +667,7 @@ Remove any associated metadata.
|
|
667
667
|
# load the gem
|
668
668
|
require 'bf_ruby2'
|
669
669
|
|
670
|
-
api_instance =
|
670
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
671
671
|
|
672
672
|
subscription_id = "subscription_id_example" # String |
|
673
673
|
|
@@ -679,7 +679,7 @@ begin
|
|
679
679
|
#Remove any associated metadata.
|
680
680
|
result = api_instance.delete_metadata_for_subscription(subscription_id, opts)
|
681
681
|
p result
|
682
|
-
rescue
|
682
|
+
rescue Bfwd::ApiError => e
|
683
683
|
puts "Exception when calling SubscriptionsApi->delete_metadata_for_subscription: #{e}"
|
684
684
|
end
|
685
685
|
```
|
@@ -718,18 +718,18 @@ Freeze the subscription.
|
|
718
718
|
# load the gem
|
719
719
|
require 'bf_ruby2'
|
720
720
|
|
721
|
-
api_instance =
|
721
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
722
722
|
|
723
723
|
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
724
724
|
|
725
|
-
request =
|
725
|
+
request = Bfwd::PauseRequest.new # PauseRequest | The request
|
726
726
|
|
727
727
|
|
728
728
|
begin
|
729
729
|
#Freeze the subscription.
|
730
730
|
result = api_instance.freeze_subscription(subscription_id, request)
|
731
731
|
p result
|
732
|
-
rescue
|
732
|
+
rescue Bfwd::ApiError => e
|
733
733
|
puts "Exception when calling SubscriptionsApi->freeze_subscription: #{e}"
|
734
734
|
end
|
735
735
|
```
|
@@ -768,7 +768,7 @@ Retrieves a collection of all subscriptions. By default 10 values are returned.
|
|
768
768
|
# load the gem
|
769
769
|
require 'bf_ruby2'
|
770
770
|
|
771
|
-
api_instance =
|
771
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
772
772
|
|
773
773
|
opts = {
|
774
774
|
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
@@ -787,7 +787,7 @@ begin
|
|
787
787
|
#Retrieves a collection of all subscriptions. By default 10 values are returned. Records are returned in natural order.
|
788
788
|
result = api_instance.get_all_subscriptions(opts)
|
789
789
|
p result
|
790
|
-
rescue
|
790
|
+
rescue Bfwd::ApiError => e
|
791
791
|
puts "Exception when calling SubscriptionsApi->get_all_subscriptions: #{e}"
|
792
792
|
end
|
793
793
|
```
|
@@ -834,7 +834,7 @@ Retrieves a collection of the coupons which can be applied to this subscription.
|
|
834
834
|
# load the gem
|
835
835
|
require 'bf_ruby2'
|
836
836
|
|
837
|
-
api_instance =
|
837
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
838
838
|
|
839
839
|
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
840
840
|
|
@@ -851,7 +851,7 @@ begin
|
|
851
851
|
#Retrieves a collection of the coupons which can be applied to this subscription.
|
852
852
|
result = api_instance.get_applicable_coupons_for_subscription(subscription_id, opts)
|
853
853
|
p result
|
854
|
-
rescue
|
854
|
+
rescue Bfwd::ApiError => e
|
855
855
|
puts "Exception when calling SubscriptionsApi->get_applicable_coupons_for_subscription: #{e}"
|
856
856
|
end
|
857
857
|
```
|
@@ -895,7 +895,7 @@ Returns all available credit-notes for the specified subscription. By default 10
|
|
895
895
|
# load the gem
|
896
896
|
require 'bf_ruby2'
|
897
897
|
|
898
|
-
api_instance =
|
898
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
899
899
|
|
900
900
|
subscription_id = "subscription_id_example" # String |
|
901
901
|
|
@@ -912,7 +912,7 @@ begin
|
|
912
912
|
#Returns all available credit-notes for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
913
913
|
result = api_instance.get_available_credit_subscription(subscription_id, opts)
|
914
914
|
p result
|
915
|
-
rescue
|
915
|
+
rescue Bfwd::ApiError => e
|
916
916
|
puts "Exception when calling SubscriptionsApi->get_available_credit_subscription: #{e}"
|
917
917
|
end
|
918
918
|
```
|
@@ -956,7 +956,7 @@ Returns all charges for the specified subscription. By default 10 values are ret
|
|
956
956
|
# load the gem
|
957
957
|
require 'bf_ruby2'
|
958
958
|
|
959
|
-
api_instance =
|
959
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
960
960
|
|
961
961
|
subscription_id = "subscription_id_example" # String |
|
962
962
|
|
@@ -975,7 +975,7 @@ begin
|
|
975
975
|
#Returns all charges for the specified subscription. By default 10 values are returned. Records are returned in natural order.
|
976
976
|
result = api_instance.get_charges_on_subscription(subscription_id, opts)
|
977
977
|
p result
|
978
|
-
rescue
|
978
|
+
rescue Bfwd::ApiError => e
|
979
979
|
puts "Exception when calling SubscriptionsApi->get_charges_on_subscription: #{e}"
|
980
980
|
end
|
981
981
|
```
|
@@ -1021,7 +1021,7 @@ Return all entities whose invoices will be aggregated by the specified subscript
|
|
1021
1021
|
# load the gem
|
1022
1022
|
require 'bf_ruby2'
|
1023
1023
|
|
1024
|
-
api_instance =
|
1024
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1025
1025
|
|
1026
1026
|
subscription_id = "subscription_id_example" # String |
|
1027
1027
|
|
@@ -1038,7 +1038,7 @@ begin
|
|
1038
1038
|
#Return all entities whose invoices will be aggregated by the specified subscription By default 10 values are returned. Records are returned in natural order.
|
1039
1039
|
result = api_instance.get_children_of_subscription(subscription_id, opts)
|
1040
1040
|
p result
|
1041
|
-
rescue
|
1041
|
+
rescue Bfwd::ApiError => e
|
1042
1042
|
puts "Exception when calling SubscriptionsApi->get_children_of_subscription: #{e}"
|
1043
1043
|
end
|
1044
1044
|
```
|
@@ -1082,7 +1082,7 @@ Retrieves a collection of the coupons and the unique codes currently applied to
|
|
1082
1082
|
# load the gem
|
1083
1083
|
require 'bf_ruby2'
|
1084
1084
|
|
1085
|
-
api_instance =
|
1085
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1086
1086
|
|
1087
1087
|
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
1088
1088
|
|
@@ -1099,7 +1099,7 @@ begin
|
|
1099
1099
|
#Retrieves a collection of the coupons and the unique codes currently applied to the subscription.
|
1100
1100
|
result = api_instance.get_coupons_on_subscription(subscription_id, opts)
|
1101
1101
|
p result
|
1102
|
-
rescue
|
1102
|
+
rescue Bfwd::ApiError => e
|
1103
1103
|
puts "Exception when calling SubscriptionsApi->get_coupons_on_subscription: #{e}"
|
1104
1104
|
end
|
1105
1105
|
```
|
@@ -1143,7 +1143,7 @@ Retrieves a collection of invoice objects of the specified state for the given s
|
|
1143
1143
|
# load the gem
|
1144
1144
|
require 'bf_ruby2'
|
1145
1145
|
|
1146
|
-
api_instance =
|
1146
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1147
1147
|
|
1148
1148
|
subscription_id = "subscription_id_example" # String | The unique id of the subscription.
|
1149
1149
|
|
@@ -1161,7 +1161,7 @@ begin
|
|
1161
1161
|
#Retrieves a collection of invoice objects of the specified state for the given subscription. By default 10 values are returned. Records are returned in natural order.
|
1162
1162
|
result = api_instance.get_invoices_for_subscription_by_state(subscription_id, state, opts)
|
1163
1163
|
p result
|
1164
|
-
rescue
|
1164
|
+
rescue Bfwd::ApiError => e
|
1165
1165
|
puts "Exception when calling SubscriptionsApi->get_invoices_for_subscription_by_state: #{e}"
|
1166
1166
|
end
|
1167
1167
|
```
|
@@ -1205,7 +1205,7 @@ Retrieve any associated metadata.
|
|
1205
1205
|
# load the gem
|
1206
1206
|
require 'bf_ruby2'
|
1207
1207
|
|
1208
|
-
api_instance =
|
1208
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1209
1209
|
|
1210
1210
|
subscription_id = "subscription_id_example" # String |
|
1211
1211
|
|
@@ -1217,7 +1217,7 @@ begin
|
|
1217
1217
|
#Retrieve any associated metadata.
|
1218
1218
|
result = api_instance.get_metadata_for_subscription(subscription_id, opts)
|
1219
1219
|
p result
|
1220
|
-
rescue
|
1220
|
+
rescue Bfwd::ApiError => e
|
1221
1221
|
puts "Exception when calling SubscriptionsApi->get_metadata_for_subscription: #{e}"
|
1222
1222
|
end
|
1223
1223
|
```
|
@@ -1256,7 +1256,7 @@ Return the parent of the given subscription.
|
|
1256
1256
|
# load the gem
|
1257
1257
|
require 'bf_ruby2'
|
1258
1258
|
|
1259
|
-
api_instance =
|
1259
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1260
1260
|
|
1261
1261
|
subscription_id = "subscription_id_example" # String |
|
1262
1262
|
|
@@ -1268,7 +1268,7 @@ begin
|
|
1268
1268
|
#Return the parent of the given subscription.
|
1269
1269
|
result = api_instance.get_parent_subscription(subscription_id, opts)
|
1270
1270
|
p result
|
1271
|
-
rescue
|
1271
|
+
rescue Bfwd::ApiError => e
|
1272
1272
|
puts "Exception when calling SubscriptionsApi->get_parent_subscription: #{e}"
|
1273
1273
|
end
|
1274
1274
|
```
|
@@ -1307,7 +1307,7 @@ Gets the subscription's current pricing-component values.
|
|
1307
1307
|
# load the gem
|
1308
1308
|
require 'bf_ruby2'
|
1309
1309
|
|
1310
|
-
api_instance =
|
1310
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1311
1311
|
|
1312
1312
|
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
1313
1313
|
|
@@ -1316,7 +1316,7 @@ begin
|
|
1316
1316
|
#Gets the subscription's current pricing-component values.
|
1317
1317
|
result = api_instance.get_pricing_component_values_of_subscription(subscription_id)
|
1318
1318
|
p result
|
1319
|
-
rescue
|
1319
|
+
rescue Bfwd::ApiError => e
|
1320
1320
|
puts "Exception when calling SubscriptionsApi->get_pricing_component_values_of_subscription: #{e}"
|
1321
1321
|
end
|
1322
1322
|
```
|
@@ -1354,7 +1354,7 @@ Retrieves a collection of subscriptions, specified by the account-ID parameter.
|
|
1354
1354
|
# load the gem
|
1355
1355
|
require 'bf_ruby2'
|
1356
1356
|
|
1357
|
-
api_instance =
|
1357
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1358
1358
|
|
1359
1359
|
account_id = "account_id_example" # String |
|
1360
1360
|
|
@@ -1372,7 +1372,7 @@ begin
|
|
1372
1372
|
#Retrieves a collection of subscriptions, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
1373
1373
|
result = api_instance.get_subscription_by_account_id(account_id, opts)
|
1374
1374
|
p result
|
1375
|
-
rescue
|
1375
|
+
rescue Bfwd::ApiError => e
|
1376
1376
|
puts "Exception when calling SubscriptionsApi->get_subscription_by_account_id: #{e}"
|
1377
1377
|
end
|
1378
1378
|
```
|
@@ -1417,7 +1417,7 @@ Retrieves a single subscription, specified by the ID parameter.
|
|
1417
1417
|
# load the gem
|
1418
1418
|
require 'bf_ruby2'
|
1419
1419
|
|
1420
|
-
api_instance =
|
1420
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1421
1421
|
|
1422
1422
|
subscription_id = "subscription_id_example" # String |
|
1423
1423
|
|
@@ -1430,7 +1430,7 @@ begin
|
|
1430
1430
|
#Retrieves a single subscription, specified by the ID parameter.
|
1431
1431
|
result = api_instance.get_subscription_by_id(subscription_id, opts)
|
1432
1432
|
p result
|
1433
|
-
rescue
|
1433
|
+
rescue Bfwd::ApiError => e
|
1434
1434
|
puts "Exception when calling SubscriptionsApi->get_subscription_by_id: #{e}"
|
1435
1435
|
end
|
1436
1436
|
```
|
@@ -1470,7 +1470,7 @@ Retrieves a collection of subscriptions, specified by the product-ID parameter.
|
|
1470
1470
|
# load the gem
|
1471
1471
|
require 'bf_ruby2'
|
1472
1472
|
|
1473
|
-
api_instance =
|
1473
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1474
1474
|
|
1475
1475
|
product_id = "product_id_example" # String | ID of the product
|
1476
1476
|
|
@@ -1488,7 +1488,7 @@ begin
|
|
1488
1488
|
#Retrieves a collection of subscriptions, specified by the product-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
1489
1489
|
result = api_instance.get_subscription_by_product_id(product_id, opts)
|
1490
1490
|
p result
|
1491
|
-
rescue
|
1491
|
+
rescue Bfwd::ApiError => e
|
1492
1492
|
puts "Exception when calling SubscriptionsApi->get_subscription_by_product_id: #{e}"
|
1493
1493
|
end
|
1494
1494
|
```
|
@@ -1533,7 +1533,7 @@ Retrieves a collection of subscriptions, specified by the product-rate-plan-ID p
|
|
1533
1533
|
# load the gem
|
1534
1534
|
require 'bf_ruby2'
|
1535
1535
|
|
1536
|
-
api_instance =
|
1536
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1537
1537
|
|
1538
1538
|
product_rate_plan_id = "product_rate_plan_id_example" # String |
|
1539
1539
|
|
@@ -1551,7 +1551,7 @@ begin
|
|
1551
1551
|
#Retrieves a collection of subscriptions, specified by the product-rate-plan-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
1552
1552
|
result = api_instance.get_subscription_by_product_rate_plan_id(product_rate_plan_id, opts)
|
1553
1553
|
p result
|
1554
|
-
rescue
|
1554
|
+
rescue Bfwd::ApiError => e
|
1555
1555
|
puts "Exception when calling SubscriptionsApi->get_subscription_by_product_rate_plan_id: #{e}"
|
1556
1556
|
end
|
1557
1557
|
```
|
@@ -1596,7 +1596,7 @@ Retrieves a collection of subscriptions, specified by the state parameter. By de
|
|
1596
1596
|
# load the gem
|
1597
1597
|
require 'bf_ruby2'
|
1598
1598
|
|
1599
|
-
api_instance =
|
1599
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1600
1600
|
|
1601
1601
|
state = "state_example" # String | The current state of the subscription, either Provisioned, AwaitingPayment, Paid or Cancelled
|
1602
1602
|
|
@@ -1614,7 +1614,7 @@ begin
|
|
1614
1614
|
#Retrieves a collection of subscriptions, specified by the state parameter. By default 10 values are returned. Records are returned in natural order.
|
1615
1615
|
result = api_instance.get_subscription_by_state(state, opts)
|
1616
1616
|
p result
|
1617
|
-
rescue
|
1617
|
+
rescue Bfwd::ApiError => e
|
1618
1618
|
puts "Exception when calling SubscriptionsApi->get_subscription_by_state: #{e}"
|
1619
1619
|
end
|
1620
1620
|
```
|
@@ -1659,7 +1659,7 @@ Retrieves a single subscription, specified by the version-ID parameter.
|
|
1659
1659
|
# load the gem
|
1660
1660
|
require 'bf_ruby2'
|
1661
1661
|
|
1662
|
-
api_instance =
|
1662
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1663
1663
|
|
1664
1664
|
version_id = "version_id_example" # String | The version-ID of the subscription.
|
1665
1665
|
|
@@ -1671,7 +1671,7 @@ begin
|
|
1671
1671
|
#Retrieves a single subscription, specified by the version-ID parameter.
|
1672
1672
|
result = api_instance.get_subscription_by_version_id(version_id, opts)
|
1673
1673
|
p result
|
1674
|
-
rescue
|
1674
|
+
rescue Bfwd::ApiError => e
|
1675
1675
|
puts "Exception when calling SubscriptionsApi->get_subscription_by_version_id: #{e}"
|
1676
1676
|
end
|
1677
1677
|
```
|
@@ -1710,7 +1710,7 @@ Retrieves a collection of subscription objects with period-end times within the
|
|
1710
1710
|
# load the gem
|
1711
1711
|
require 'bf_ruby2'
|
1712
1712
|
|
1713
|
-
api_instance =
|
1713
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1714
1714
|
|
1715
1715
|
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
1716
1716
|
|
@@ -1728,7 +1728,7 @@ begin
|
|
1728
1728
|
#Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
1729
1729
|
result = api_instance.get_subscriptions_by_initial_period_start(lower_threshold, upper_threshold, opts)
|
1730
1730
|
p result
|
1731
|
-
rescue
|
1731
|
+
rescue Bfwd::ApiError => e
|
1732
1732
|
puts "Exception when calling SubscriptionsApi->get_subscriptions_by_initial_period_start: #{e}"
|
1733
1733
|
end
|
1734
1734
|
```
|
@@ -1772,7 +1772,7 @@ Retrieves a collection of subscription objects with period-end times within the
|
|
1772
1772
|
# load the gem
|
1773
1773
|
require 'bf_ruby2'
|
1774
1774
|
|
1775
|
-
api_instance =
|
1775
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1776
1776
|
|
1777
1777
|
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
1778
1778
|
|
@@ -1790,7 +1790,7 @@ begin
|
|
1790
1790
|
#Retrieves a collection of subscription objects with period-end times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
1791
1791
|
result = api_instance.get_subscriptions_by_period_end(lower_threshold, upper_threshold, opts)
|
1792
1792
|
p result
|
1793
|
-
rescue
|
1793
|
+
rescue Bfwd::ApiError => e
|
1794
1794
|
puts "Exception when calling SubscriptionsApi->get_subscriptions_by_period_end: #{e}"
|
1795
1795
|
end
|
1796
1796
|
```
|
@@ -1834,7 +1834,7 @@ Retrieves a collection of subscription objects with period-start times within th
|
|
1834
1834
|
# load the gem
|
1835
1835
|
require 'bf_ruby2'
|
1836
1836
|
|
1837
|
-
api_instance =
|
1837
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1838
1838
|
|
1839
1839
|
lower_threshold = "lower_threshold_example" # String | The UTC DateTime specifying the start of the result period.
|
1840
1840
|
|
@@ -1852,7 +1852,7 @@ begin
|
|
1852
1852
|
#Retrieves a collection of subscription objects with period-start times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
1853
1853
|
result = api_instance.get_subscriptions_by_period_start(lower_threshold, upper_threshold, opts)
|
1854
1854
|
p result
|
1855
|
-
rescue
|
1855
|
+
rescue Bfwd::ApiError => e
|
1856
1856
|
puts "Exception when calling SubscriptionsApi->get_subscriptions_by_period_start: #{e}"
|
1857
1857
|
end
|
1858
1858
|
```
|
@@ -1896,7 +1896,7 @@ Retrieves a collection of subscription objects whose successful periods count fa
|
|
1896
1896
|
# load the gem
|
1897
1897
|
require 'bf_ruby2'
|
1898
1898
|
|
1899
|
-
api_instance =
|
1899
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1900
1900
|
|
1901
1901
|
lower_threshold = 56 # Integer | The lower threshold of the range
|
1902
1902
|
|
@@ -1914,7 +1914,7 @@ begin
|
|
1914
1914
|
#Retrieves a collection of subscription objects whose successful periods count falls within the range specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
1915
1915
|
result = api_instance.get_subscriptions_by_successful_periods(lower_threshold, upper_threshold, opts)
|
1916
1916
|
p result
|
1917
|
-
rescue
|
1917
|
+
rescue Bfwd::ApiError => e
|
1918
1918
|
puts "Exception when calling SubscriptionsApi->get_subscriptions_by_successful_periods: #{e}"
|
1919
1919
|
end
|
1920
1920
|
```
|
@@ -1958,7 +1958,7 @@ No authorization required
|
|
1958
1958
|
# load the gem
|
1959
1959
|
require 'bf_ruby2'
|
1960
1960
|
|
1961
|
-
api_instance =
|
1961
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
1962
1962
|
|
1963
1963
|
query_string = "query_string_example" # String | The query string used to search.
|
1964
1964
|
|
@@ -1975,7 +1975,7 @@ begin
|
|
1975
1975
|
#
|
1976
1976
|
result = api_instance.get_swagger_subscription(query_string, opts)
|
1977
1977
|
p result
|
1978
|
-
rescue
|
1978
|
+
rescue Bfwd::ApiError => e
|
1979
1979
|
puts "Exception when calling SubscriptionsApi->get_swagger_subscription: #{e}"
|
1980
1980
|
end
|
1981
1981
|
```
|
@@ -2019,7 +2019,7 @@ Retrieves a collection timer amendments for the specified subscription.. By defa
|
|
2019
2019
|
# load the gem
|
2020
2020
|
require 'bf_ruby2'
|
2021
2021
|
|
2022
|
-
api_instance =
|
2022
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2023
2023
|
|
2024
2024
|
subscription_id = "subscription_id_example" # String |
|
2025
2025
|
|
@@ -2038,7 +2038,7 @@ begin
|
|
2038
2038
|
#Retrieves a collection timer amendments for the specified subscription.. By default 10 values are returned. Records are returned in natural order.
|
2039
2039
|
result = api_instance.get_timers_for_subscription(subscription_id, opts)
|
2040
2040
|
p result
|
2041
|
-
rescue
|
2041
|
+
rescue Bfwd::ApiError => e
|
2042
2042
|
puts "Exception when calling SubscriptionsApi->get_timers_for_subscription: #{e}"
|
2043
2043
|
end
|
2044
2044
|
```
|
@@ -2084,16 +2084,16 @@ Import a subscription.
|
|
2084
2084
|
# load the gem
|
2085
2085
|
require 'bf_ruby2'
|
2086
2086
|
|
2087
|
-
api_instance =
|
2087
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2088
2088
|
|
2089
|
-
request =
|
2089
|
+
request = Bfwd::BillingEntityBase.new # BillingEntityBase | The request
|
2090
2090
|
|
2091
2091
|
|
2092
2092
|
begin
|
2093
2093
|
#Import a subscription.
|
2094
2094
|
result = api_instance.import_subscription(request)
|
2095
2095
|
p result
|
2096
|
-
rescue
|
2096
|
+
rescue Bfwd::ApiError => e
|
2097
2097
|
puts "Exception when calling SubscriptionsApi->import_subscription: #{e}"
|
2098
2098
|
end
|
2099
2099
|
```
|
@@ -2131,18 +2131,18 @@ Invoice any outstanding charges for the subscription.
|
|
2131
2131
|
# load the gem
|
2132
2132
|
require 'bf_ruby2'
|
2133
2133
|
|
2134
|
-
api_instance =
|
2134
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2135
2135
|
|
2136
2136
|
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
2137
2137
|
|
2138
|
-
charge =
|
2138
|
+
charge = Bfwd::InvoiceChargeRequest.new # InvoiceChargeRequest | The charge request
|
2139
2139
|
|
2140
2140
|
|
2141
2141
|
begin
|
2142
2142
|
#Invoice any outstanding charges for the subscription.
|
2143
2143
|
result = api_instance.invoice_charges_on_subscription(subscription_id, charge)
|
2144
2144
|
p result
|
2145
|
-
rescue
|
2145
|
+
rescue Bfwd::ApiError => e
|
2146
2146
|
puts "Exception when calling SubscriptionsApi->invoice_charges_on_subscription: #{e}"
|
2147
2147
|
end
|
2148
2148
|
```
|
@@ -2181,18 +2181,18 @@ Migrate the subscription to a new plan.
|
|
2181
2181
|
# load the gem
|
2182
2182
|
require 'bf_ruby2'
|
2183
2183
|
|
2184
|
-
api_instance =
|
2184
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2185
2185
|
|
2186
2186
|
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
2187
2187
|
|
2188
|
-
request =
|
2188
|
+
request = Bfwd::MigrationRequest.new # MigrationRequest | The migration request
|
2189
2189
|
|
2190
2190
|
|
2191
2191
|
begin
|
2192
2192
|
#Migrate the subscription to a new plan.
|
2193
2193
|
result = api_instance.migrate_subscription(subscription_id, request)
|
2194
2194
|
p result
|
2195
|
-
rescue
|
2195
|
+
rescue Bfwd::ApiError => e
|
2196
2196
|
puts "Exception when calling SubscriptionsApi->migrate_subscription: #{e}"
|
2197
2197
|
end
|
2198
2198
|
```
|
@@ -2231,7 +2231,7 @@ Removes the coupon from the subscription.
|
|
2231
2231
|
# load the gem
|
2232
2232
|
require 'bf_ruby2'
|
2233
2233
|
|
2234
|
-
api_instance =
|
2234
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2235
2235
|
|
2236
2236
|
subscription_id = "subscription_id_example" # String |
|
2237
2237
|
|
@@ -2245,7 +2245,7 @@ begin
|
|
2245
2245
|
#Removes the coupon from the subscription.
|
2246
2246
|
result = api_instance.remove_coupon_from_subscription(subscription_id, coupon_code, opts)
|
2247
2247
|
p result
|
2248
|
-
rescue
|
2248
|
+
rescue Bfwd::ApiError => e
|
2249
2249
|
puts "Exception when calling SubscriptionsApi->remove_coupon_from_subscription: #{e}"
|
2250
2250
|
end
|
2251
2251
|
```
|
@@ -2285,7 +2285,7 @@ Decrease the amount of credit available to the specified subscription.
|
|
2285
2285
|
# load the gem
|
2286
2286
|
require 'bf_ruby2'
|
2287
2287
|
|
2288
|
-
api_instance =
|
2288
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2289
2289
|
|
2290
2290
|
subscription_id = "subscription_id_example" # String |
|
2291
2291
|
|
@@ -2299,7 +2299,7 @@ begin
|
|
2299
2299
|
#Decrease the amount of credit available to the specified subscription.
|
2300
2300
|
result = api_instance.remove_credit_from_subscription(subscription_id, value, opts)
|
2301
2301
|
p result
|
2302
|
-
rescue
|
2302
|
+
rescue Bfwd::ApiError => e
|
2303
2303
|
puts "Exception when calling SubscriptionsApi->remove_credit_from_subscription: #{e}"
|
2304
2304
|
end
|
2305
2305
|
```
|
@@ -2339,7 +2339,7 @@ Removes the specified payment method for the given subscription.
|
|
2339
2339
|
# load the gem
|
2340
2340
|
require 'bf_ruby2'
|
2341
2341
|
|
2342
|
-
api_instance =
|
2342
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2343
2343
|
|
2344
2344
|
subscription_id = "subscription_id_example" # String |
|
2345
2345
|
|
@@ -2353,7 +2353,7 @@ begin
|
|
2353
2353
|
#Removes the specified payment method for the given subscription.
|
2354
2354
|
result = api_instance.remove_payment_method_from_subscription(subscription_id, payment_method_id, opts)
|
2355
2355
|
p result
|
2356
|
-
rescue
|
2356
|
+
rescue Bfwd::ApiError => e
|
2357
2357
|
puts "Exception when calling SubscriptionsApi->remove_payment_method_from_subscription: #{e}"
|
2358
2358
|
end
|
2359
2359
|
```
|
@@ -2393,7 +2393,7 @@ Discards from the subscription any scheduled changes in the value of the specifi
|
|
2393
2393
|
# load the gem
|
2394
2394
|
require 'bf_ruby2'
|
2395
2395
|
|
2396
|
-
api_instance =
|
2396
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2397
2397
|
|
2398
2398
|
subscription_id = "subscription_id_example" # String |
|
2399
2399
|
|
@@ -2407,7 +2407,7 @@ begin
|
|
2407
2407
|
#Discards from the subscription any scheduled changes in the value of the specified pricing-component.
|
2408
2408
|
result = api_instance.remove_pricing_component_value_change_from_subscription(subscription_id, pricing_component, opts)
|
2409
2409
|
p result
|
2410
|
-
rescue
|
2410
|
+
rescue Bfwd::ApiError => e
|
2411
2411
|
puts "Exception when calling SubscriptionsApi->remove_pricing_component_value_change_from_subscription: #{e}"
|
2412
2412
|
end
|
2413
2413
|
```
|
@@ -2447,18 +2447,18 @@ Resume the frozen subscription.
|
|
2447
2447
|
# load the gem
|
2448
2448
|
require 'bf_ruby2'
|
2449
2449
|
|
2450
|
-
api_instance =
|
2450
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2451
2451
|
|
2452
2452
|
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
2453
2453
|
|
2454
|
-
request =
|
2454
|
+
request = Bfwd::ResumeRequest.new # ResumeRequest | The request
|
2455
2455
|
|
2456
2456
|
|
2457
2457
|
begin
|
2458
2458
|
#Resume the frozen subscription.
|
2459
2459
|
result = api_instance.resume_subscription(subscription_id, request)
|
2460
2460
|
p result
|
2461
|
-
rescue
|
2461
|
+
rescue Bfwd::ApiError => e
|
2462
2462
|
puts "Exception when calling SubscriptionsApi->resume_subscription: #{e}"
|
2463
2463
|
end
|
2464
2464
|
```
|
@@ -2497,18 +2497,18 @@ Revives a cancelled subscription and returns it to its previous state
|
|
2497
2497
|
# load the gem
|
2498
2498
|
require 'bf_ruby2'
|
2499
2499
|
|
2500
|
-
api_instance =
|
2500
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2501
2501
|
|
2502
2502
|
subscription_id = "subscription_id_example" # String |
|
2503
2503
|
|
2504
|
-
request =
|
2504
|
+
request = Bfwd::ReviveSubscriptionRequest.new # ReviveSubscriptionRequest | The revive request
|
2505
2505
|
|
2506
2506
|
|
2507
2507
|
begin
|
2508
2508
|
#Revives a cancelled subscription and returns it to its previous state
|
2509
2509
|
result = api_instance.revive_subscription(subscription_id, request)
|
2510
2510
|
p result
|
2511
|
-
rescue
|
2511
|
+
rescue Bfwd::ApiError => e
|
2512
2512
|
puts "Exception when calling SubscriptionsApi->revive_subscription: #{e}"
|
2513
2513
|
end
|
2514
2514
|
```
|
@@ -2547,9 +2547,9 @@ Remove any existing metadata keys and create the provided data.
|
|
2547
2547
|
# load the gem
|
2548
2548
|
require 'bf_ruby2'
|
2549
2549
|
|
2550
|
-
api_instance =
|
2550
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2551
2551
|
|
2552
|
-
metadata =
|
2552
|
+
metadata = Bfwd::DynamicMetadata.new # DynamicMetadata |
|
2553
2553
|
|
2554
2554
|
subscription_id = "subscription_id_example" # String |
|
2555
2555
|
|
@@ -2561,7 +2561,7 @@ begin
|
|
2561
2561
|
#Remove any existing metadata keys and create the provided data.
|
2562
2562
|
result = api_instance.set_metadata_for_subscription(metadata, subscription_id, opts)
|
2563
2563
|
p result
|
2564
|
-
rescue
|
2564
|
+
rescue Bfwd::ApiError => e
|
2565
2565
|
puts "Exception when calling SubscriptionsApi->set_metadata_for_subscription: #{e}"
|
2566
2566
|
end
|
2567
2567
|
```
|
@@ -2601,18 +2601,18 @@ Sets upon this subscription a new value for the specified pricing-component with
|
|
2601
2601
|
# load the gem
|
2602
2602
|
require 'bf_ruby2'
|
2603
2603
|
|
2604
|
-
api_instance =
|
2604
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2605
2605
|
|
2606
2606
|
subscription_id = "subscription_id_example" # String | ID of the subscription.
|
2607
2607
|
|
2608
|
-
pricing_component_value =
|
2608
|
+
pricing_component_value = Bfwd::PricingComponentValue.new # PricingComponentValue | The pricing-component-value request
|
2609
2609
|
|
2610
2610
|
|
2611
2611
|
begin
|
2612
2612
|
#Sets upon this subscription a new value for the specified pricing-component without performing an upgrade.
|
2613
2613
|
result = api_instance.set_pricing_component_value_on_subscription(subscription_id, pricing_component_value)
|
2614
2614
|
p result
|
2615
|
-
rescue
|
2615
|
+
rescue Bfwd::ApiError => e
|
2616
2616
|
puts "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription: #{e}"
|
2617
2617
|
end
|
2618
2618
|
```
|
@@ -2651,18 +2651,18 @@ Upgrades/downgrades this subscription to some new value for the specified pricin
|
|
2651
2651
|
# load the gem
|
2652
2652
|
require 'bf_ruby2'
|
2653
2653
|
|
2654
|
-
api_instance =
|
2654
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2655
2655
|
|
2656
2656
|
subscription_id = "subscription_id_example" # String | ID of the subscription
|
2657
2657
|
|
2658
|
-
request =
|
2658
|
+
request = Bfwd::BatchUpdatePricingComponentValuesRequest.new # BatchUpdatePricingComponentValuesRequest | The batched update requests.
|
2659
2659
|
|
2660
2660
|
|
2661
2661
|
begin
|
2662
2662
|
#Upgrades/downgrades this subscription to some new value for the specified pricing-component. This endpoint can do synchronous (immediate) and asynchronous (delayed) updates. A synchronous update will generate a charge/credit for an UPGRADE or DOWNGRADE. An asynchronous update will generate an amendment scheduled for the end of the billing period. By default each update is considered synchronous, you can make them asynchronous setting 'applyChangeNow' to 'false'.
|
2663
2663
|
result = api_instance.set_pricing_component_value_on_subscription_batch_update(subscription_id, request)
|
2664
2664
|
p result
|
2665
|
-
rescue
|
2665
|
+
rescue Bfwd::ApiError => e
|
2666
2666
|
puts "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription_batch_update: #{e}"
|
2667
2667
|
end
|
2668
2668
|
```
|
@@ -2701,20 +2701,20 @@ Upgrades/downgrades this subscription to some new value for the specified pricin
|
|
2701
2701
|
# load the gem
|
2702
2702
|
require 'bf_ruby2'
|
2703
2703
|
|
2704
|
-
api_instance =
|
2704
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2705
2705
|
|
2706
2706
|
subscription_id = "subscription_id_example" # String |
|
2707
2707
|
|
2708
2708
|
pricing_component = "pricing_component_example" # String | Name or ID of the pricing-component.
|
2709
2709
|
|
2710
|
-
value =
|
2710
|
+
value = Bfwd::PricingComponentValueRequest.new # PricingComponentValueRequest | The pricing-component-value request
|
2711
2711
|
|
2712
2712
|
|
2713
2713
|
begin
|
2714
2714
|
#Upgrades/downgrades this subscription to some new value for the specified pricing-component.
|
2715
2715
|
result = api_instance.set_pricing_component_value_on_subscription_v2(subscription_id, pricing_component, value)
|
2716
2716
|
p result
|
2717
|
-
rescue
|
2717
|
+
rescue Bfwd::ApiError => e
|
2718
2718
|
puts "Exception when calling SubscriptionsApi->set_pricing_component_value_on_subscription_v2: #{e}"
|
2719
2719
|
end
|
2720
2720
|
```
|
@@ -2754,16 +2754,16 @@ Update a subscription.
|
|
2754
2754
|
# load the gem
|
2755
2755
|
require 'bf_ruby2'
|
2756
2756
|
|
2757
|
-
api_instance =
|
2757
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2758
2758
|
|
2759
|
-
subscription =
|
2759
|
+
subscription = Bfwd::Subscription.new # Subscription | The subscription object to be updated.
|
2760
2760
|
|
2761
2761
|
|
2762
2762
|
begin
|
2763
2763
|
#Update a subscription.
|
2764
2764
|
result = api_instance.update_subscription(subscription)
|
2765
2765
|
p result
|
2766
|
-
rescue
|
2766
|
+
rescue Bfwd::ApiError => e
|
2767
2767
|
puts "Exception when calling SubscriptionsApi->update_subscription: #{e}"
|
2768
2768
|
end
|
2769
2769
|
```
|
@@ -2801,16 +2801,16 @@ Update a subscription (V2).
|
|
2801
2801
|
# load the gem
|
2802
2802
|
require 'bf_ruby2'
|
2803
2803
|
|
2804
|
-
api_instance =
|
2804
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2805
2805
|
|
2806
|
-
request =
|
2806
|
+
request = Bfwd::UpdateSubscriptionRequest.new # UpdateSubscriptionRequest |
|
2807
2807
|
|
2808
2808
|
|
2809
2809
|
begin
|
2810
2810
|
#Update a subscription (V2).
|
2811
2811
|
result = api_instance.update_subscription_v2(request)
|
2812
2812
|
p result
|
2813
|
-
rescue
|
2813
|
+
rescue Bfwd::ApiError => e
|
2814
2814
|
puts "Exception when calling SubscriptionsApi->update_subscription_v2: #{e}"
|
2815
2815
|
end
|
2816
2816
|
```
|
@@ -2848,9 +2848,9 @@ Update any existing metadata key-values and insert any new key-values, no keys w
|
|
2848
2848
|
# load the gem
|
2849
2849
|
require 'bf_ruby2'
|
2850
2850
|
|
2851
|
-
api_instance =
|
2851
|
+
api_instance = Bfwd::SubscriptionsApi.new
|
2852
2852
|
|
2853
|
-
metadata =
|
2853
|
+
metadata = Bfwd::DynamicMetadata.new # DynamicMetadata |
|
2854
2854
|
|
2855
2855
|
subscription_id = "subscription_id_example" # String |
|
2856
2856
|
|
@@ -2862,7 +2862,7 @@ begin
|
|
2862
2862
|
#Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
2863
2863
|
result = api_instance.upsert_metadata_for_subscription(metadata, subscription_id, opts)
|
2864
2864
|
p result
|
2865
|
-
rescue
|
2865
|
+
rescue Bfwd::ApiError => e
|
2866
2866
|
puts "Exception when calling SubscriptionsApi->upsert_metadata_for_subscription: #{e}"
|
2867
2867
|
end
|
2868
2868
|
```
|