bf_ruby2 1.2016.229
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/LICENSE +201 -0
- data/README.md +824 -0
- data/bf_ruby2-1.0.0.gem +0 -0
- data/bf_ruby2.gemspec +55 -0
- data/docs/APIConfigurationPagedMetadata.md +14 -0
- data/docs/APIQuote.md +36 -0
- data/docs/APIQuotePagedMetadata.md +14 -0
- data/docs/APIQuoteResponseQuantity.md +25 -0
- data/docs/Account.md +21 -0
- data/docs/AccountLTVResultPagedMetadata.md +14 -0
- data/docs/AccountPagedMetadata.md +14 -0
- data/docs/AccountPaymentsResultPagedMetadata.md +14 -0
- data/docs/AccountsApi.md +1021 -0
- data/docs/AddChargeRequest.md +23 -0
- data/docs/AddCouponCodeRequest.md +11 -0
- data/docs/AddPaymentMethodRequest.md +8 -0
- data/docs/AddTaxationStrategyRequest.md +11 -0
- data/docs/Address.md +23 -0
- data/docs/AddressPagedMetadata.md +14 -0
- data/docs/AddressesApi.md +104 -0
- data/docs/AggregatingComponent.md +17 -0
- data/docs/Amendment.md +19 -0
- data/docs/AmendmentDiscardAmendment.md +20 -0
- data/docs/AmendmentPagedMetadata.md +14 -0
- data/docs/AmendmentPriceNTimePagedMetadata.md +14 -0
- data/docs/AmendmentsApi.md +639 -0
- data/docs/AnalyticsApi.md +641 -0
- data/docs/AuditEntry.md +17 -0
- data/docs/AuditEntryPagedMetadata.md +14 -0
- data/docs/AuditlogsApi.md +308 -0
- data/docs/AuthCaptureRequest.md +17 -0
- data/docs/AuthorizeNetTokenPagedMetadata.md +14 -0
- data/docs/BFError.md +11 -0
- data/docs/BFPermission.md +17 -0
- data/docs/BFPermissionPagedMetadata.md +14 -0
- data/docs/BankAccountVerificationPagedMetadata.md +14 -0
- data/docs/BillforwardManagedPaymentsResultPagedMetadata.md +14 -0
- data/docs/BillingEntityBase.md +8 -0
- data/docs/BraintreeAuthCaptureRequest.md +19 -0
- data/docs/BraintreeCaptureRequest.md +20 -0
- data/docs/BraintreeTokenPagedMetadata.md +14 -0
- data/docs/CancelSubscriptionRequest.md +14 -0
- data/docs/CancellationAmendment.md +24 -0
- data/docs/CassChurnResultPagedMetadata.md +14 -0
- data/docs/CassPaymentResultPagedMetadata.md +14 -0
- data/docs/CassUpgradeResultPagedMetadata.md +14 -0
- data/docs/ChargesApi.md +408 -0
- data/docs/Client.md +21 -0
- data/docs/ClientPagedMetadata.md +14 -0
- data/docs/ClientsApi.md +215 -0
- data/docs/ComponentChange.md +20 -0
- data/docs/ComponentCost.md +9 -0
- data/docs/CompoundUsage.md +11 -0
- data/docs/CompoundUsageSession.md +11 -0
- data/docs/ConfigurationsApi.md +221 -0
- data/docs/Coupon.md +32 -0
- data/docs/CouponBook.md +21 -0
- data/docs/CouponBookDefinition.md +24 -0
- data/docs/CouponBookDefinitionPagedMetadata.md +14 -0
- data/docs/CouponBookPagedMetadata.md +14 -0
- data/docs/CouponDefinition.md +26 -0
- data/docs/CouponDefinitionPagedMetadata.md +14 -0
- data/docs/CouponDiscount.md +18 -0
- data/docs/CouponDiscountEstimate.md +13 -0
- data/docs/CouponInstance.md +26 -0
- data/docs/CouponInstanceExistingValue.md +15 -0
- data/docs/CouponInstancePagedMetadata.md +14 -0
- data/docs/CouponModifierBase.md +22 -0
- data/docs/CouponModifierBasePagedMetadata.md +14 -0
- data/docs/CouponPagedMetadata.md +14 -0
- data/docs/CouponRule.md +24 -0
- data/docs/CouponRulePagedMetadata.md +14 -0
- data/docs/CouponUniqueCodesRequest.md +11 -0
- data/docs/CouponUniqueCodesResponse.md +10 -0
- data/docs/CouponUniqueCodesResponsePagedMetadata.md +14 -0
- data/docs/CouponWrapperResponse.md +13 -0
- data/docs/CouponbookApi.md +496 -0
- data/docs/CouponbookdefinitionApi.md +329 -0
- data/docs/CoupondefinitionApi.md +267 -0
- data/docs/CouponinstanceApi.md +578 -0
- data/docs/CouponmodifierApi.md +369 -0
- data/docs/CouponruleApi.md +269 -0
- data/docs/CouponsApi.md +456 -0
- data/docs/CreateAccountProfileRequest.md +20 -0
- data/docs/CreateAccountRequest.md +13 -0
- data/docs/CreateAddressRequest.md +17 -0
- data/docs/CreateAggregatingComponentRequest.md +10 -0
- data/docs/CreateAggregatingSubscriptionRequest.md +21 -0
- data/docs/CreateProfileAddressRequest.md +16 -0
- data/docs/CreateSubscriptionBatchRequest.md +10 -0
- data/docs/CreateSubscriptionChargeAmendment.md +29 -0
- data/docs/CreateSubscriptionRequest.md +26 -0
- data/docs/CreditAccountRequest.md +13 -0
- data/docs/CreditNote.md +21 -0
- data/docs/CreditNotePagedMetadata.md +14 -0
- data/docs/CreditSubscriptionRequest.md +12 -0
- data/docs/CreditnotesApi.md +339 -0
- data/docs/CybersourceTokenPagedMetadata.md +14 -0
- data/docs/CybersourcetokensApi.md +259 -0
- data/docs/DataSynchronisationAppConfigurationPagedMetadata.md +14 -0
- data/docs/DataSynchronisationConfiguration.md +20 -0
- data/docs/DataSynchronisationConfigurationPagedMetadata.md +14 -0
- data/docs/DataSynchronizationJobPagedMetadata.md +14 -0
- data/docs/DebtsResultPagedMetadata.md +14 -0
- data/docs/DunningLine.md +18 -0
- data/docs/DunningLinePagedMetadata.md +14 -0
- data/docs/DunninglinesApi.md +328 -0
- data/docs/DynamicMetadata.md +7 -0
- data/docs/Email.md +35 -0
- data/docs/EmailPagedMetadata.md +14 -0
- data/docs/EmailProvider.md +18 -0
- data/docs/EmailProviderPagedMetadata.md +14 -0
- data/docs/EmailSubscription.md +20 -0
- data/docs/EmailSubscriptionPagedMetadata.md +14 -0
- data/docs/EmailprovidersApi.md +221 -0
- data/docs/EmailsApi.md +164 -0
- data/docs/EmailsubscriptionsApi.md +273 -0
- data/docs/EndTrialAmendment.md +19 -0
- data/docs/Event.md +15 -0
- data/docs/EventData.md +9 -0
- data/docs/FileSham.md +7 -0
- data/docs/FixedTerm.md +24 -0
- data/docs/FixedTermDefinitionPagedMetadata.md +14 -0
- data/docs/FixedTermExpiryAmendment.md +20 -0
- data/docs/FixedTermPagedMetadata.md +14 -0
- data/docs/FixedtermdefinitionsApi.md +104 -0
- data/docs/FixedtermsApi.md +56 -0
- data/docs/FlatPricingComponent.md +32 -0
- data/docs/ImportInvoiceLine.md +16 -0
- data/docs/InsertableBillingEntity.md +21 -0
- data/docs/Invoice.md +54 -0
- data/docs/InvoiceChargeRequest.md +11 -0
- data/docs/InvoiceLine.md +38 -0
- data/docs/InvoiceLinePayment.md +36 -0
- data/docs/InvoiceLinePaymentPagedMetadata.md +14 -0
- data/docs/InvoiceNextExecutionAttemptAmendment.md +21 -0
- data/docs/InvoiceOutstandingChargesAmendment.md +20 -0
- data/docs/InvoicePagedMetadata.md +14 -0
- data/docs/InvoicePayment.md +22 -0
- data/docs/InvoiceRecalculationAmendment.md +23 -0
- data/docs/InvoiceRecalculationRequest.md +12 -0
- data/docs/InvoicesApi.md +2474 -0
- data/docs/IssueInvoiceAmendment.md +20 -0
- data/docs/MetadataApi.md +210 -0
- data/docs/MetadataKeyValuesPagedMetadata.md +14 -0
- data/docs/MigrationRequest.md +16 -0
- data/docs/ModelAlias.md +14 -0
- data/docs/MutableBillingEntity.md +27 -0
- data/docs/Notification.md +27 -0
- data/docs/NotificationPagedMetadata.md +14 -0
- data/docs/NotificationsApi.md +370 -0
- data/docs/Organization.md +21 -0
- data/docs/OrganizationPagedMetadata.md +14 -0
- data/docs/OrganizationsApi.md +378 -0
- data/docs/Password.md +14 -0
- data/docs/PasswordPagedMetadata.md +14 -0
- data/docs/PasswordResetRequest.md +8 -0
- data/docs/PasswordsApi.md +56 -0
- data/docs/PauseRequest.md +9 -0
- data/docs/Payment.md +24 -0
- data/docs/PaymentMethod.md +32 -0
- data/docs/PaymentMethodPagedMetadata.md +14 -0
- data/docs/PaymentMethodSubscriptionLink.md +17 -0
- data/docs/PaymentMethodSubscriptionLinkPagedMetadata.md +14 -0
- data/docs/PaymentPagedMetadata.md +14 -0
- data/docs/PaymentRetryRequest.md +9 -0
- data/docs/PaymentmethodsApi.md +445 -0
- data/docs/PaymentmethodsubscriptionlinksApi.md +107 -0
- data/docs/PaymentsApi.md +464 -0
- data/docs/PendingComponentValueChange.md +11 -0
- data/docs/Period.md +16 -0
- data/docs/PeriodPagedMetadata.md +14 -0
- data/docs/PeriodsApi.md +125 -0
- data/docs/PermissionActionEntityPagedMetadata.md +14 -0
- data/docs/PermissionResourceEntityPagedMetadata.md +14 -0
- data/docs/PermissionsApi.md +322 -0
- data/docs/PriceCalculationPagedMetadata.md +14 -0
- data/docs/PricingComponent.md +32 -0
- data/docs/PricingComponentCouponModifier.md +22 -0
- data/docs/PricingComponentMigrationValue.md +12 -0
- data/docs/PricingComponentPagedMetadata.md +14 -0
- data/docs/PricingComponentQuantityRequest.md +10 -0
- data/docs/PricingComponentTier.md +19 -0
- data/docs/PricingComponentTierPagedMetadata.md +14 -0
- data/docs/PricingComponentValue.md +20 -0
- data/docs/PricingComponentValueChangeAmendment.md +22 -0
- data/docs/PricingComponentValueChangePagedMetadata.md +14 -0
- data/docs/PricingComponentValueMigrationAmendmentMapping.md +16 -0
- data/docs/PricingComponentValuePagedMetadata.md +14 -0
- data/docs/PricingComponentValueRequest.md +12 -0
- data/docs/PricingComponentValueResponsePagedMetadata.md +14 -0
- data/docs/PricingcalculatorApi.md +152 -0
- data/docs/PricingcomponentsApi.md +339 -0
- data/docs/PricingcomponenttiersApi.md +281 -0
- data/docs/PricingcomponentvaluechangesApi.md +345 -0
- data/docs/PricingcomponentvaluesApi.md +287 -0
- data/docs/Product.md +25 -0
- data/docs/ProductCouponModifier.md +22 -0
- data/docs/ProductPagedMetadata.md +14 -0
- data/docs/ProductPaymentsResultPagedMetadata.md +14 -0
- data/docs/ProductRatePlan.md +39 -0
- data/docs/ProductRatePlanMigrationAmendment.md +27 -0
- data/docs/ProductRatePlanPagedMetadata.md +14 -0
- data/docs/ProductRatePlanPaymentsResultPagedMetadata.md +14 -0
- data/docs/ProductrateplansApi.md +786 -0
- data/docs/ProductsApi.md +493 -0
- data/docs/Profile.md +25 -0
- data/docs/ProfilePagedMetadata.md +14 -0
- data/docs/ProfilesApi.md +287 -0
- data/docs/QuoteRequest.md +24 -0
- data/docs/QuoteRequestValue.md +11 -0
- data/docs/QuotesApi.md +56 -0
- data/docs/RecalculateChargeRequest.md +15 -0
- data/docs/Receipt.md +36 -0
- data/docs/ReceiptPagedMetadata.md +14 -0
- data/docs/ReceiptsApi.md +421 -0
- data/docs/Refund.md +35 -0
- data/docs/RefundPagedMetadata.md +14 -0
- data/docs/RefundsApi.md +432 -0
- data/docs/ResumeRequest.md +10 -0
- data/docs/ResumeSubscriptionAmendment.md +19 -0
- data/docs/RevenueAttribution.md +31 -0
- data/docs/RevenueAttributionPagedMetadata.md +14 -0
- data/docs/ReviveSubscriptionRequest.md +8 -0
- data/docs/Role.md +19 -0
- data/docs/RolePagedMetadata.md +14 -0
- data/docs/RolesApi.md +327 -0
- data/docs/RuleSatisfaction.md +11 -0
- data/docs/SearchApi.md +70 -0
- data/docs/SearchResultPagedMetadata.md +14 -0
- data/docs/ServiceEndAmendment.md +19 -0
- data/docs/StripeACHTokenPagedMetadata.md +14 -0
- data/docs/StripeAuthCaptureRequest.md +20 -0
- data/docs/StripeObject.md +7 -0
- data/docs/StripeTokenPagedMetadata.md +14 -0
- data/docs/Subscription.md +47 -0
- data/docs/SubscriptionCancellationPagedMetadata.md +14 -0
- data/docs/SubscriptionCharge.md +32 -0
- data/docs/SubscriptionChargePagedMetadata.md +14 -0
- data/docs/SubscriptionLTVResultPagedMetadata.md +14 -0
- data/docs/SubscriptionPagedMetadata.md +14 -0
- data/docs/SubscriptionsApi.md +2841 -0
- data/docs/SwaggerTypeList.md +9 -0
- data/docs/SwaggerTypeListInv.md +8 -0
- data/docs/SwaggerTypeListSubs.md +9 -0
- data/docs/SynchAppConfigsApi.md +208 -0
- data/docs/SynchConfigsApi.md +317 -0
- data/docs/SynchJobsApi.md +421 -0
- data/docs/TaxationLinkPagedMetadata.md +14 -0
- data/docs/TaxationStrategyPagedMetadata.md +14 -0
- data/docs/TaxationlinksApi.md +339 -0
- data/docs/TaxationstrategiesApi.md +514 -0
- data/docs/TieredPricingComponent.md +32 -0
- data/docs/TieredVolumePricingComponent.md +32 -0
- data/docs/TimeApi.md +56 -0
- data/docs/TimeRequest.md +16 -0
- data/docs/TimeResponse.md +18 -0
- data/docs/TimeResponsePagedMetadata.md +14 -0
- data/docs/TimeZone.md +11 -0
- data/docs/TimerAmendment.md +26 -0
- data/docs/TokenizationApi.md +340 -0
- data/docs/TokenizationPreAuthPagedMetadata.md +14 -0
- data/docs/TrustCommerceTokenPagedMetadata.md +14 -0
- data/docs/UnitDiscount.md +11 -0
- data/docs/UnitOfMeasure.md +16 -0
- data/docs/UnitOfMeasureCouponModifier.md +22 -0
- data/docs/UnitOfMeasurePagedMetadata.md +14 -0
- data/docs/UnitofmeasureApi.md +215 -0
- data/docs/UpdateAddressRequest.md +18 -0
- data/docs/UpdateComponentValueAmendment.md +23 -0
- data/docs/UpdateProfileRequest.md +22 -0
- data/docs/UpdateRoleRequest.md +13 -0
- data/docs/UpdateSubscriptionRequest.md +16 -0
- data/docs/Usage.md +26 -0
- data/docs/UsageApi.md +296 -0
- data/docs/UsagePagedMetadata.md +14 -0
- data/docs/UsagePeriodPagedMetadata.md +14 -0
- data/docs/UsageRoundingStrategyPagedMetadata.md +14 -0
- data/docs/UsageSession.md +21 -0
- data/docs/UsageSessionPagedMetadata.md +14 -0
- data/docs/UsageperiodsApi.md +194 -0
- data/docs/UsageroundingstrategiesApi.md +228 -0
- data/docs/UsagesessionsApi.md +224 -0
- data/docs/User.md +21 -0
- data/docs/UserCreationRequest.md +17 -0
- data/docs/UserCreationResponsePagedMetadata.md +14 -0
- data/docs/UserPagedMetadata.md +14 -0
- data/docs/Username.md +13 -0
- data/docs/UsernamePagedMetadata.md +14 -0
- data/docs/UsernamesApi.md +56 -0
- data/docs/UsersApi.md +564 -0
- data/docs/VaultedgatewaysApi.md +648 -0
- data/docs/WebhookPagedMetadata.md +14 -0
- data/docs/WebhooksApi.md +366 -0
- data/git_push.sh +67 -0
- data/lib/bf_ruby2/api/accounts_api.rb +1257 -0
- data/lib/bf_ruby2/api/addresses_api.rb +148 -0
- data/lib/bf_ruby2/api/amendments_api.rb +819 -0
- data/lib/bf_ruby2/api/analytics_api.rb +815 -0
- data/lib/bf_ruby2/api/auditlogs_api.rb +410 -0
- data/lib/bf_ruby2/api/charges_api.rb +527 -0
- data/lib/bf_ruby2/api/clients_api.rb +282 -0
- data/lib/bf_ruby2/api/configurations_api.rb +298 -0
- data/lib/bf_ruby2/api/couponbook_api.rb +619 -0
- data/lib/bf_ruby2/api/couponbookdefinition_api.rb +420 -0
- data/lib/bf_ruby2/api/coupondefinition_api.rb +342 -0
- data/lib/bf_ruby2/api/couponinstance_api.rb +737 -0
- data/lib/bf_ruby2/api/couponmodifier_api.rb +456 -0
- data/lib/bf_ruby2/api/couponrule_api.rb +342 -0
- data/lib/bf_ruby2/api/coupons_api.rb +580 -0
- data/lib/bf_ruby2/api/creditnotes_api.rb +438 -0
- data/lib/bf_ruby2/api/cybersourcetokens_api.rb +330 -0
- data/lib/bf_ruby2/api/dunninglines_api.rb +422 -0
- data/lib/bf_ruby2/api/emailproviders_api.rb +288 -0
- data/lib/bf_ruby2/api/emails_api.rb +214 -0
- data/lib/bf_ruby2/api/emailsubscriptions_api.rb +364 -0
- data/lib/bf_ruby2/api/fixedtermdefinitions_api.rb +148 -0
- data/lib/bf_ruby2/api/fixedterms_api.rb +91 -0
- data/lib/bf_ruby2/api/invoices_api.rb +3066 -0
- data/lib/bf_ruby2/api/metadata_api.rb +266 -0
- data/lib/bf_ruby2/api/notifications_api.rb +480 -0
- data/lib/bf_ruby2/api/organizations_api.rb +476 -0
- data/lib/bf_ruby2/api/passwords_api.rb +91 -0
- data/lib/bf_ruby2/api/paymentmethods_api.rb +565 -0
- data/lib/bf_ruby2/api/paymentmethodsubscriptionlinks_api.rb +153 -0
- data/lib/bf_ruby2/api/payments_api.rb +601 -0
- data/lib/bf_ruby2/api/periods_api.rb +180 -0
- data/lib/bf_ruby2/api/permissions_api.rb +408 -0
- data/lib/bf_ruby2/api/pricingcalculator_api.rb +205 -0
- data/lib/bf_ruby2/api/pricingcomponents_api.rb +438 -0
- data/lib/bf_ruby2/api/pricingcomponenttiers_api.rb +369 -0
- data/lib/bf_ruby2/api/pricingcomponentvaluechanges_api.rb +447 -0
- data/lib/bf_ruby2/api/pricingcomponentvalues_api.rb +378 -0
- data/lib/bf_ruby2/api/productrateplans_api.rb +971 -0
- data/lib/bf_ruby2/api/products_api.rb +611 -0
- data/lib/bf_ruby2/api/profiles_api.rb +375 -0
- data/lib/bf_ruby2/api/quotes_api.rb +91 -0
- data/lib/bf_ruby2/api/receipts_api.rb +559 -0
- data/lib/bf_ruby2/api/refunds_api.rb +540 -0
- data/lib/bf_ruby2/api/roles_api.rb +421 -0
- data/lib/bf_ruby2/api/search_api.rb +109 -0
- data/lib/bf_ruby2/api/subscriptions_api.rb +3490 -0
- data/lib/bf_ruby2/api/synch_app_configs_api.rb +272 -0
- data/lib/bf_ruby2/api/synch_configs_api.rb +403 -0
- data/lib/bf_ruby2/api/synch_jobs_api.rb +535 -0
- data/lib/bf_ruby2/api/taxationlinks_api.rb +438 -0
- data/lib/bf_ruby2/api/taxationstrategies_api.rb +660 -0
- data/lib/bf_ruby2/api/time_api.rb +91 -0
- data/lib/bf_ruby2/api/tokenization_api.rb +431 -0
- data/lib/bf_ruby2/api/unitofmeasure_api.rb +282 -0
- data/lib/bf_ruby2/api/usage_api.rb +389 -0
- data/lib/bf_ruby2/api/usageperiods_api.rb +267 -0
- data/lib/bf_ruby2/api/usageroundingstrategies_api.rb +304 -0
- data/lib/bf_ruby2/api/usagesessions_api.rb +298 -0
- data/lib/bf_ruby2/api/usernames_api.rb +91 -0
- data/lib/bf_ruby2/api/users_api.rb +692 -0
- data/lib/bf_ruby2/api/vaultedgateways_api.rb +787 -0
- data/lib/bf_ruby2/api/webhooks_api.rb +461 -0
- data/lib/bf_ruby2/api_client.rb +378 -0
- data/lib/bf_ruby2/api_error.rb +47 -0
- data/lib/bf_ruby2/configuration.rb +207 -0
- data/lib/bf_ruby2/models/account.rb +335 -0
- data/lib/bf_ruby2/models/account_ltv_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/account_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/account_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/add_charge_request.rb +414 -0
- data/lib/bf_ruby2/models/add_coupon_code_request.rb +231 -0
- data/lib/bf_ruby2/models/add_payment_method_request.rb +200 -0
- data/lib/bf_ruby2/models/add_taxation_strategy_request.rb +230 -0
- data/lib/bf_ruby2/models/address.rb +359 -0
- data/lib/bf_ruby2/models/address_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/aggregating_component.rb +294 -0
- data/lib/bf_ruby2/models/amendment.rb +374 -0
- data/lib/bf_ruby2/models/amendment_discard_amendment.rb +385 -0
- data/lib/bf_ruby2/models/amendment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/amendment_price_n_time_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_quote.rb +525 -0
- data/lib/bf_ruby2/models/api_quote_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/api_quote_response_quantity.rb +405 -0
- data/lib/bf_ruby2/models/audit_entry.rb +359 -0
- data/lib/bf_ruby2/models/audit_entry_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/auth_capture_request.rb +337 -0
- data/lib/bf_ruby2/models/authorize_net_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/bank_account_verification_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/bf_error.rb +265 -0
- data/lib/bf_ruby2/models/bf_permission.rb +337 -0
- data/lib/bf_ruby2/models/bf_permission_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/billforward_managed_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/billing_entity_base.rb +200 -0
- data/lib/bf_ruby2/models/braintree_auth_capture_request.rb +358 -0
- data/lib/bf_ruby2/models/braintree_capture_request.rb +327 -0
- data/lib/bf_ruby2/models/braintree_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cancel_subscription_request.rb +301 -0
- data/lib/bf_ruby2/models/cancellation_amendment.rb +451 -0
- data/lib/bf_ruby2/models/cass_churn_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cass_payment_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/cass_upgrade_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/client.rb +342 -0
- data/lib/bf_ruby2/models/client_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/component_change.rb +373 -0
- data/lib/bf_ruby2/models/component_cost.rb +208 -0
- data/lib/bf_ruby2/models/compound_usage.rb +234 -0
- data/lib/bf_ruby2/models/compound_usage_session.rb +233 -0
- data/lib/bf_ruby2/models/coupon.rb +484 -0
- data/lib/bf_ruby2/models/coupon_book.rb +342 -0
- data/lib/bf_ruby2/models/coupon_book_definition.rb +417 -0
- data/lib/bf_ruby2/models/coupon_book_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_book_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_definition.rb +454 -0
- data/lib/bf_ruby2/models/coupon_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_discount.rb +298 -0
- data/lib/bf_ruby2/models/coupon_discount_estimate.rb +258 -0
- data/lib/bf_ruby2/models/coupon_instance.rb +426 -0
- data/lib/bf_ruby2/models/coupon_instance_existing_value.rb +272 -0
- data/lib/bf_ruby2/models/coupon_instance_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_modifier_base.rb +410 -0
- data/lib/bf_ruby2/models/coupon_modifier_base_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_rule.rb +470 -0
- data/lib/bf_ruby2/models/coupon_rule_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_request.rb +232 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_response.rb +219 -0
- data/lib/bf_ruby2/models/coupon_unique_codes_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/coupon_wrapper_response.rb +250 -0
- data/lib/bf_ruby2/models/create_account_profile_request.rb +323 -0
- data/lib/bf_ruby2/models/create_account_request.rb +248 -0
- data/lib/bf_ruby2/models/create_address_request.rb +298 -0
- data/lib/bf_ruby2/models/create_aggregating_component_request.rb +221 -0
- data/lib/bf_ruby2/models/create_aggregating_subscription_request.rb +393 -0
- data/lib/bf_ruby2/models/create_profile_address_request.rb +287 -0
- data/lib/bf_ruby2/models/create_subscription_batch_request.rb +222 -0
- data/lib/bf_ruby2/models/create_subscription_charge_amendment.rb +514 -0
- data/lib/bf_ruby2/models/create_subscription_request.rb +444 -0
- data/lib/bf_ruby2/models/credit_account_request.rb +252 -0
- data/lib/bf_ruby2/models/credit_note.rb +368 -0
- data/lib/bf_ruby2/models/credit_note_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/credit_subscription_request.rb +241 -0
- data/lib/bf_ruby2/models/cybersource_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronisation_app_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronisation_configuration.rb +362 -0
- data/lib/bf_ruby2/models/data_synchronisation_configuration_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/data_synchronization_job_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/debts_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/dunning_line.rb +354 -0
- data/lib/bf_ruby2/models/dunning_line_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/dynamic_metadata.rb +190 -0
- data/lib/bf_ruby2/models/email.rb +518 -0
- data/lib/bf_ruby2/models/email_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/email_provider.rb +302 -0
- data/lib/bf_ruby2/models/email_provider_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/email_subscription.rb +364 -0
- data/lib/bf_ruby2/models/email_subscription_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/end_trial_amendment.rb +374 -0
- data/lib/bf_ruby2/models/event.rb +272 -0
- data/lib/bf_ruby2/models/event_data.rb +212 -0
- data/lib/bf_ruby2/models/file_sham.rb +190 -0
- data/lib/bf_ruby2/models/fixed_term.rb +419 -0
- data/lib/bf_ruby2/models/fixed_term_definition_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/fixed_term_expiry_amendment.rb +385 -0
- data/lib/bf_ruby2/models/fixed_term_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/flat_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/import_invoice_line.rb +271 -0
- data/lib/bf_ruby2/models/insertable_billing_entity.rb +384 -0
- data/lib/bf_ruby2/models/invoice.rb +746 -0
- data/lib/bf_ruby2/models/invoice_charge_request.rb +267 -0
- data/lib/bf_ruby2/models/invoice_line.rb +575 -0
- data/lib/bf_ruby2/models/invoice_line_payment.rb +539 -0
- data/lib/bf_ruby2/models/invoice_line_payment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/invoice_next_execution_attempt_amendment.rb +398 -0
- data/lib/bf_ruby2/models/invoice_outstanding_charges_amendment.rb +385 -0
- data/lib/bf_ruby2/models/invoice_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/invoice_payment.rb +384 -0
- data/lib/bf_ruby2/models/invoice_recalculation_amendment.rb +444 -0
- data/lib/bf_ruby2/models/invoice_recalculation_request.rb +293 -0
- data/lib/bf_ruby2/models/issue_invoice_amendment.rb +385 -0
- data/lib/bf_ruby2/models/metadata_key_values_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/migration_request.rb +332 -0
- data/lib/bf_ruby2/models/model_alias.rb +266 -0
- data/lib/bf_ruby2/models/mutable_billing_entity.rb +472 -0
- data/lib/bf_ruby2/models/notification.rb +472 -0
- data/lib/bf_ruby2/models/notification_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/organization.rb +349 -0
- data/lib/bf_ruby2/models/organization_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/password.rb +266 -0
- data/lib/bf_ruby2/models/password_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/password_reset_request.rb +201 -0
- data/lib/bf_ruby2/models/pause_request.rb +210 -0
- data/lib/bf_ruby2/models/payment.rb +417 -0
- data/lib/bf_ruby2/models/payment_method.rb +487 -0
- data/lib/bf_ruby2/models/payment_method_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_method_subscription_link.rb +291 -0
- data/lib/bf_ruby2/models/payment_method_subscription_link_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/payment_retry_request.rb +210 -0
- data/lib/bf_ruby2/models/pending_component_value_change.rb +226 -0
- data/lib/bf_ruby2/models/period.rb +330 -0
- data/lib/bf_ruby2/models/period_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/permission_action_entity_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/permission_resource_entity_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/price_calculation_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/pricing_component_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/pricing_component_migration_value.rb +242 -0
- data/lib/bf_ruby2/models/pricing_component_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_quantity_request.rb +220 -0
- data/lib/bf_ruby2/models/pricing_component_tier.rb +346 -0
- data/lib/bf_ruby2/models/pricing_component_tier_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value.rb +323 -0
- data/lib/bf_ruby2/models/pricing_component_value_change_amendment.rb +419 -0
- data/lib/bf_ruby2/models/pricing_component_value_change_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value_migration_amendment_mapping.rb +283 -0
- data/lib/bf_ruby2/models/pricing_component_value_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/pricing_component_value_request.rb +288 -0
- data/lib/bf_ruby2/models/pricing_component_value_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product.rb +435 -0
- data/lib/bf_ruby2/models/product_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/product_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_rate_plan.rb +658 -0
- data/lib/bf_ruby2/models/product_rate_plan_migration_amendment.rb +483 -0
- data/lib/bf_ruby2/models/product_rate_plan_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/product_rate_plan_payments_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/profile.rb +378 -0
- data/lib/bf_ruby2/models/profile_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/quote_request.rb +431 -0
- data/lib/bf_ruby2/models/quote_request_value.rb +232 -0
- data/lib/bf_ruby2/models/recalculate_charge_request.rb +318 -0
- data/lib/bf_ruby2/models/receipt.rb +535 -0
- data/lib/bf_ruby2/models/receipt_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/refund.rb +535 -0
- data/lib/bf_ruby2/models/refund_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/resume_request.rb +222 -0
- data/lib/bf_ruby2/models/resume_subscription_amendment.rb +374 -0
- data/lib/bf_ruby2/models/revenue_attribution.rb +451 -0
- data/lib/bf_ruby2/models/revenue_attribution_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/revive_subscription_request.rb +200 -0
- data/lib/bf_ruby2/models/role.rb +318 -0
- data/lib/bf_ruby2/models/role_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/rule_satisfaction.rb +234 -0
- data/lib/bf_ruby2/models/search_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/service_end_amendment.rb +374 -0
- data/lib/bf_ruby2/models/stripe_ach_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/stripe_auth_capture_request.rb +367 -0
- data/lib/bf_ruby2/models/stripe_object.rb +190 -0
- data/lib/bf_ruby2/models/stripe_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription.rb +681 -0
- data/lib/bf_ruby2/models/subscription_cancellation_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_charge.rb +529 -0
- data/lib/bf_ruby2/models/subscription_charge_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_ltv_result_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/subscription_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/swagger_type_list.rb +210 -0
- data/lib/bf_ruby2/models/swagger_type_list_inv.rb +201 -0
- data/lib/bf_ruby2/models/swagger_type_list_subs.rb +212 -0
- data/lib/bf_ruby2/models/taxation_link_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/taxation_strategy_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/tiered_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/tiered_volume_pricing_component.rb +546 -0
- data/lib/bf_ruby2/models/time_request.rb +323 -0
- data/lib/bf_ruby2/models/time_response.rb +345 -0
- data/lib/bf_ruby2/models/time_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/time_zone.rb +226 -0
- data/lib/bf_ruby2/models/timer_amendment.rb +485 -0
- data/lib/bf_ruby2/models/tokenization_pre_auth_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/trust_commerce_token_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/unit_discount.rb +226 -0
- data/lib/bf_ruby2/models/unit_of_measure.rb +286 -0
- data/lib/bf_ruby2/models/unit_of_measure_coupon_modifier.rb +410 -0
- data/lib/bf_ruby2/models/unit_of_measure_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/update_address_request.rb +303 -0
- data/lib/bf_ruby2/models/update_component_value_amendment.rb +418 -0
- data/lib/bf_ruby2/models/update_profile_request.rb +342 -0
- data/lib/bf_ruby2/models/update_role_request.rb +253 -0
- data/lib/bf_ruby2/models/update_subscription_request.rb +328 -0
- data/lib/bf_ruby2/models/usage.rb +423 -0
- data/lib/bf_ruby2/models/usage_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_period_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_rounding_strategy_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/usage_session.rb +368 -0
- data/lib/bf_ruby2/models/usage_session_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/user.rb +352 -0
- data/lib/bf_ruby2/models/user_creation_request.rb +302 -0
- data/lib/bf_ruby2/models/user_creation_response_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/user_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/username.rb +253 -0
- data/lib/bf_ruby2/models/username_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/models/webhook_paged_metadata.rb +269 -0
- data/lib/bf_ruby2/version.rb +26 -0
- data/lib/bf_ruby2.rb +340 -0
- data/setup.scratch.rb +33 -0
- data/spec/api/accounts_api_spec.rb +318 -0
- data/spec/api/addresses_api_spec.rb +70 -0
- data/spec/api/amendments_api_spec.rb +220 -0
- data/spec/api/analytics_api_spec.rb +220 -0
- data/spec/api/auditlogs_api_spec.rb +131 -0
- data/spec/api/charges_api_spec.rb +156 -0
- data/spec/api/clients_api_spec.rb +100 -0
- data/spec/api/configurations_api_spec.rb +103 -0
- data/spec/api/couponbook_api_spec.rb +175 -0
- data/spec/api/couponbookdefinition_api_spec.rb +131 -0
- data/spec/api/coupondefinition_api_spec.rb +113 -0
- data/spec/api/couponinstance_api_spec.rb +203 -0
- data/spec/api/couponmodifier_api_spec.rb +138 -0
- data/spec/api/couponrule_api_spec.rb +113 -0
- data/spec/api/coupons_api_spec.rb +168 -0
- data/spec/api/creditnotes_api_spec.rb +135 -0
- data/spec/api/cybersourcetokens_api_spec.rb +109 -0
- data/spec/api/dunninglines_api_spec.rb +131 -0
- data/spec/api/emailproviders_api_spec.rb +102 -0
- data/spec/api/emails_api_spec.rb +85 -0
- data/spec/api/emailsubscriptions_api_spec.rb +115 -0
- data/spec/api/fixedtermdefinitions_api_spec.rb +70 -0
- data/spec/api/fixedterms_api_spec.rb +58 -0
- data/spec/api/invoices_api_spec.rb +727 -0
- data/spec/api/metadata_api_spec.rb +96 -0
- data/spec/api/notifications_api_spec.rb +148 -0
- data/spec/api/organizations_api_spec.rb +143 -0
- data/spec/api/passwords_api_spec.rb +58 -0
- data/spec/api/paymentmethods_api_spec.rb +163 -0
- data/spec/api/paymentmethodsubscriptionlinks_api_spec.rb +71 -0
- data/spec/api/payments_api_spec.rb +172 -0
- data/spec/api/periods_api_spec.rb +79 -0
- data/spec/api/permissions_api_spec.rb +127 -0
- data/spec/api/pricingcalculator_api_spec.rb +82 -0
- data/spec/api/pricingcomponents_api_spec.rb +136 -0
- data/spec/api/pricingcomponenttiers_api_spec.rb +120 -0
- data/spec/api/pricingcomponentvaluechanges_api_spec.rb +138 -0
- data/spec/api/pricingcomponentvalues_api_spec.rb +123 -0
- data/spec/api/productrateplans_api_spec.rb +254 -0
- data/spec/api/products_api_spec.rb +173 -0
- data/spec/api/profiles_api_spec.rb +122 -0
- data/spec/api/quotes_api_spec.rb +58 -0
- data/spec/api/receipts_api_spec.rb +164 -0
- data/spec/api/refunds_api_spec.rb +156 -0
- data/spec/api/roles_api_spec.rb +129 -0
- data/spec/api/search_api_spec.rb +64 -0
- data/spec/api/subscriptions_api_spec.rb +809 -0
- data/spec/api/synch_app_configs_api_spec.rb +96 -0
- data/spec/api/synch_configs_api_spec.rb +125 -0
- data/spec/api/synch_jobs_api_spec.rb +151 -0
- data/spec/api/taxationlinks_api_spec.rb +136 -0
- data/spec/api/taxationstrategies_api_spec.rb +185 -0
- data/spec/api/time_api_spec.rb +58 -0
- data/spec/api/tokenization_api_spec.rb +138 -0
- data/spec/api/unitofmeasure_api_spec.rb +100 -0
- data/spec/api/usage_api_spec.rb +125 -0
- data/spec/api/usageperiods_api_spec.rb +99 -0
- data/spec/api/usageroundingstrategies_api_spec.rb +106 -0
- data/spec/api/usagesessions_api_spec.rb +104 -0
- data/spec/api/usernames_api_spec.rb +58 -0
- data/spec/api/users_api_spec.rb +187 -0
- data/spec/api/vaultedgateways_api_spec.rb +206 -0
- data/spec/api/webhooks_api_spec.rb +138 -0
- data/spec/api_client_spec.rb +237 -0
- data/spec/configuration_spec.rb +53 -0
- data/spec/models/account_ltv_result_paged_metadata_spec.rb +89 -0
- data/spec/models/account_paged_metadata_spec.rb +89 -0
- data/spec/models/account_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/account_spec.rb +131 -0
- data/spec/models/add_charge_request_spec.rb +155 -0
- data/spec/models/add_coupon_code_request_spec.rb +71 -0
- data/spec/models/add_payment_method_request_spec.rb +53 -0
- data/spec/models/add_taxation_strategy_request_spec.rb +71 -0
- data/spec/models/address_paged_metadata_spec.rb +89 -0
- data/spec/models/address_spec.rb +143 -0
- data/spec/models/aggregating_component_spec.rb +107 -0
- data/spec/models/amendment_discard_amendment_spec.rb +137 -0
- data/spec/models/amendment_paged_metadata_spec.rb +89 -0
- data/spec/models/amendment_price_n_time_paged_metadata_spec.rb +89 -0
- data/spec/models/amendment_spec.rb +131 -0
- data/spec/models/api_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/api_quote_paged_metadata_spec.rb +89 -0
- data/spec/models/api_quote_response_quantity_spec.rb +159 -0
- data/spec/models/api_quote_spec.rb +225 -0
- data/spec/models/audit_entry_paged_metadata_spec.rb +89 -0
- data/spec/models/audit_entry_spec.rb +119 -0
- data/spec/models/auth_capture_request_spec.rb +115 -0
- data/spec/models/authorize_net_token_paged_metadata_spec.rb +89 -0
- data/spec/models/bank_account_verification_paged_metadata_spec.rb +89 -0
- data/spec/models/bf_error_spec.rb +75 -0
- data/spec/models/bf_permission_paged_metadata_spec.rb +89 -0
- data/spec/models/bf_permission_spec.rb +115 -0
- data/spec/models/billforward_managed_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/billing_entity_base_spec.rb +53 -0
- data/spec/models/braintree_auth_capture_request_spec.rb +127 -0
- data/spec/models/braintree_capture_request_spec.rb +125 -0
- data/spec/models/braintree_token_paged_metadata_spec.rb +89 -0
- data/spec/models/cancel_subscription_request_spec.rb +97 -0
- data/spec/models/cancellation_amendment_spec.rb +169 -0
- data/spec/models/cass_churn_result_paged_metadata_spec.rb +89 -0
- data/spec/models/cass_payment_result_paged_metadata_spec.rb +89 -0
- data/spec/models/cass_upgrade_result_paged_metadata_spec.rb +89 -0
- data/spec/models/client_paged_metadata_spec.rb +89 -0
- data/spec/models/client_spec.rb +131 -0
- data/spec/models/component_change_spec.rb +133 -0
- data/spec/models/component_cost_spec.rb +59 -0
- data/spec/models/compound_usage_session_spec.rb +71 -0
- data/spec/models/compound_usage_spec.rb +71 -0
- data/spec/models/coupon_book_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_book_definition_spec.rb +157 -0
- data/spec/models/coupon_book_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_book_spec.rb +131 -0
- data/spec/models/coupon_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_definition_spec.rb +173 -0
- data/spec/models/coupon_discount_estimate_spec.rb +83 -0
- data/spec/models/coupon_discount_spec.rb +113 -0
- data/spec/models/coupon_instance_existing_value_spec.rb +95 -0
- data/spec/models/coupon_instance_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_instance_spec.rb +165 -0
- data/spec/models/coupon_modifier_base_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_modifier_base_spec.rb +149 -0
- data/spec/models/coupon_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_rule_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_rule_spec.rb +173 -0
- data/spec/models/coupon_spec.rb +201 -0
- data/spec/models/coupon_unique_codes_request_spec.rb +71 -0
- data/spec/models/coupon_unique_codes_response_paged_metadata_spec.rb +89 -0
- data/spec/models/coupon_unique_codes_response_spec.rb +65 -0
- data/spec/models/coupon_wrapper_response_spec.rb +83 -0
- data/spec/models/create_account_profile_request_spec.rb +125 -0
- data/spec/models/create_account_request_spec.rb +83 -0
- data/spec/models/create_address_request_spec.rb +107 -0
- data/spec/models/create_aggregating_component_request_spec.rb +65 -0
- data/spec/models/create_aggregating_subscription_request_spec.rb +143 -0
- data/spec/models/create_profile_address_request_spec.rb +101 -0
- data/spec/models/create_subscription_batch_request_spec.rb +65 -0
- data/spec/models/create_subscription_charge_amendment_spec.rb +203 -0
- data/spec/models/create_subscription_request_spec.rb +173 -0
- data/spec/models/credit_account_request_spec.rb +83 -0
- data/spec/models/credit_note_paged_metadata_spec.rb +89 -0
- data/spec/models/credit_note_spec.rb +135 -0
- data/spec/models/credit_subscription_request_spec.rb +77 -0
- data/spec/models/cybersource_token_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_app_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_configuration_paged_metadata_spec.rb +89 -0
- data/spec/models/data_synchronisation_configuration_spec.rb +129 -0
- data/spec/models/data_synchronization_job_paged_metadata_spec.rb +89 -0
- data/spec/models/debts_result_paged_metadata_spec.rb +89 -0
- data/spec/models/dunning_line_paged_metadata_spec.rb +89 -0
- data/spec/models/dunning_line_spec.rb +121 -0
- data/spec/models/dynamic_metadata_spec.rb +47 -0
- data/spec/models/email_paged_metadata_spec.rb +89 -0
- data/spec/models/email_provider_paged_metadata_spec.rb +89 -0
- data/spec/models/email_provider_spec.rb +113 -0
- data/spec/models/email_spec.rb +223 -0
- data/spec/models/email_subscription_paged_metadata_spec.rb +89 -0
- data/spec/models/email_subscription_spec.rb +133 -0
- data/spec/models/end_trial_amendment_spec.rb +131 -0
- data/spec/models/event_data_spec.rb +59 -0
- data/spec/models/event_spec.rb +95 -0
- data/spec/models/file_sham_spec.rb +47 -0
- data/spec/models/fixed_term_definition_paged_metadata_spec.rb +89 -0
- data/spec/models/fixed_term_expiry_amendment_spec.rb +137 -0
- data/spec/models/fixed_term_paged_metadata_spec.rb +89 -0
- data/spec/models/fixed_term_spec.rb +157 -0
- data/spec/models/flat_pricing_component_spec.rb +221 -0
- data/spec/models/import_invoice_line_spec.rb +101 -0
- data/spec/models/insertable_billing_entity_spec.rb +139 -0
- data/spec/models/invoice_charge_request_spec.rb +75 -0
- data/spec/models/invoice_line_payment_paged_metadata_spec.rb +89 -0
- data/spec/models/invoice_line_payment_spec.rb +225 -0
- data/spec/models/invoice_line_spec.rb +245 -0
- data/spec/models/invoice_next_execution_attempt_amendment_spec.rb +143 -0
- data/spec/models/invoice_outstanding_charges_amendment_spec.rb +137 -0
- data/spec/models/invoice_paged_metadata_spec.rb +89 -0
- data/spec/models/invoice_payment_spec.rb +141 -0
- data/spec/models/invoice_recalculation_amendment_spec.rb +163 -0
- data/spec/models/invoice_recalculation_request_spec.rb +85 -0
- data/spec/models/invoice_spec.rb +341 -0
- data/spec/models/issue_invoice_amendment_spec.rb +137 -0
- data/spec/models/metadata_key_values_paged_metadata_spec.rb +89 -0
- data/spec/models/migration_request_spec.rb +109 -0
- data/spec/models/model_alias_spec.rb +89 -0
- data/spec/models/mutable_billing_entity_spec.rb +183 -0
- data/spec/models/notification_paged_metadata_spec.rb +89 -0
- data/spec/models/notification_spec.rb +183 -0
- data/spec/models/organization_paged_metadata_spec.rb +89 -0
- data/spec/models/organization_spec.rb +131 -0
- data/spec/models/password_paged_metadata_spec.rb +89 -0
- data/spec/models/password_reset_request_spec.rb +53 -0
- data/spec/models/password_spec.rb +89 -0
- data/spec/models/pause_request_spec.rb +59 -0
- data/spec/models/payment_method_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_method_spec.rb +205 -0
- data/spec/models/payment_method_subscription_link_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_method_subscription_link_spec.rb +107 -0
- data/spec/models/payment_paged_metadata_spec.rb +89 -0
- data/spec/models/payment_retry_request_spec.rb +59 -0
- data/spec/models/payment_spec.rb +157 -0
- data/spec/models/pending_component_value_change_spec.rb +71 -0
- data/spec/models/period_paged_metadata_spec.rb +89 -0
- data/spec/models/period_spec.rb +109 -0
- data/spec/models/permission_action_entity_paged_metadata_spec.rb +89 -0
- data/spec/models/permission_resource_entity_paged_metadata_spec.rb +89 -0
- data/spec/models/price_calculation_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_coupon_modifier_spec.rb +149 -0
- data/spec/models/pricing_component_migration_value_spec.rb +77 -0
- data/spec/models/pricing_component_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_quantity_request_spec.rb +65 -0
- data/spec/models/pricing_component_spec.rb +221 -0
- data/spec/models/pricing_component_tier_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_tier_spec.rb +123 -0
- data/spec/models/pricing_component_value_change_amendment_spec.rb +153 -0
- data/spec/models/pricing_component_value_change_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_migration_amendment_mapping_spec.rb +101 -0
- data/spec/models/pricing_component_value_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_request_spec.rb +85 -0
- data/spec/models/pricing_component_value_response_paged_metadata_spec.rb +89 -0
- data/spec/models/pricing_component_value_spec.rb +125 -0
- data/spec/models/product_coupon_modifier_spec.rb +149 -0
- data/spec/models/product_paged_metadata_spec.rb +89 -0
- data/spec/models/product_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_migration_amendment_spec.rb +187 -0
- data/spec/models/product_rate_plan_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_payments_result_paged_metadata_spec.rb +89 -0
- data/spec/models/product_rate_plan_spec.rb +275 -0
- data/spec/models/product_spec.rb +167 -0
- data/spec/models/profile_paged_metadata_spec.rb +89 -0
- data/spec/models/profile_spec.rb +155 -0
- data/spec/models/quote_request_spec.rb +161 -0
- data/spec/models/quote_request_value_spec.rb +71 -0
- data/spec/models/recalculate_charge_request_spec.rb +103 -0
- data/spec/models/receipt_paged_metadata_spec.rb +89 -0
- data/spec/models/receipt_spec.rb +237 -0
- data/spec/models/refund_paged_metadata_spec.rb +89 -0
- data/spec/models/refund_spec.rb +227 -0
- data/spec/models/resume_request_spec.rb +65 -0
- data/spec/models/resume_subscription_amendment_spec.rb +131 -0
- data/spec/models/revenue_attribution_paged_metadata_spec.rb +89 -0
- data/spec/models/revenue_attribution_spec.rb +191 -0
- data/spec/models/revive_subscription_request_spec.rb +53 -0
- data/spec/models/role_paged_metadata_spec.rb +89 -0
- data/spec/models/role_spec.rb +119 -0
- data/spec/models/rule_satisfaction_spec.rb +71 -0
- data/spec/models/search_result_paged_metadata_spec.rb +89 -0
- data/spec/models/service_end_amendment_spec.rb +131 -0
- data/spec/models/stripe_ach_token_paged_metadata_spec.rb +89 -0
- data/spec/models/stripe_auth_capture_request_spec.rb +133 -0
- data/spec/models/stripe_object_spec.rb +47 -0
- data/spec/models/stripe_token_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_cancellation_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_charge_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_charge_spec.rb +217 -0
- data/spec/models/subscription_ltv_result_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_paged_metadata_spec.rb +89 -0
- data/spec/models/subscription_spec.rb +303 -0
- data/spec/models/swagger_type_list_inv_spec.rb +53 -0
- data/spec/models/swagger_type_list_spec.rb +59 -0
- data/spec/models/swagger_type_list_subs_spec.rb +59 -0
- data/spec/models/taxation_link_paged_metadata_spec.rb +89 -0
- data/spec/models/taxation_strategy_paged_metadata_spec.rb +89 -0
- data/spec/models/tiered_pricing_component_spec.rb +221 -0
- data/spec/models/tiered_volume_pricing_component_spec.rb +221 -0
- data/spec/models/time_request_spec.rb +105 -0
- data/spec/models/time_response_paged_metadata_spec.rb +89 -0
- data/spec/models/time_response_spec.rb +117 -0
- data/spec/models/time_zone_spec.rb +71 -0
- data/spec/models/timer_amendment_spec.rb +189 -0
- data/spec/models/tokenization_pre_auth_paged_metadata_spec.rb +89 -0
- data/spec/models/trust_commerce_token_paged_metadata_spec.rb +89 -0
- data/spec/models/unit_discount_spec.rb +71 -0
- data/spec/models/unit_of_measure_coupon_modifier_spec.rb +149 -0
- data/spec/models/unit_of_measure_paged_metadata_spec.rb +89 -0
- data/spec/models/unit_of_measure_spec.rb +101 -0
- data/spec/models/update_address_request_spec.rb +113 -0
- data/spec/models/update_component_value_amendment_spec.rb +155 -0
- data/spec/models/update_profile_request_spec.rb +137 -0
- data/spec/models/update_role_request_spec.rb +83 -0
- data/spec/models/update_subscription_request_spec.rb +109 -0
- data/spec/models/usage_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_period_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_rounding_strategy_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_session_paged_metadata_spec.rb +89 -0
- data/spec/models/usage_session_spec.rb +135 -0
- data/spec/models/usage_spec.rb +165 -0
- data/spec/models/user_creation_request_spec.rb +107 -0
- data/spec/models/user_creation_response_paged_metadata_spec.rb +89 -0
- data/spec/models/user_paged_metadata_spec.rb +89 -0
- data/spec/models/user_spec.rb +131 -0
- data/spec/models/username_paged_metadata_spec.rb +89 -0
- data/spec/models/username_spec.rb +83 -0
- data/spec/models/webhook_paged_metadata_spec.rb +89 -0
- data/spec/spec_helper.rb +122 -0
- metadata +1401 -0
data/docs/CouponRule.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# BillForward::CouponRule
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**parent_rule_id** | **String** | { \"description\" : \"ID of the parent of this coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
7
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
8
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional]
|
|
9
|
+
**updated** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was last updated.\", \"verbs\":[] } | [optional]
|
|
10
|
+
**id** | **String** | { \"description\" : \"ID of the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [optional]
|
|
11
|
+
**organization_id** | **String** | { \"description\" : \"ID of the organization associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
12
|
+
**coupon_definition_id** | **String** | { \"description\" : \"ID of the coupon-definition associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
13
|
+
**subject** | **String** | { \"description\" : \"The subject of the coupon-rule. The coupon-rule can operate on either the user or subscription that the coupon-instance is associated with.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
14
|
+
**polarity** | **String** | { \"description\" : \"Specifies whether the rule's result will affect the application of the coupon-instance positively or negatively.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
15
|
+
**verb** | **String** | { \"description\" : \"The verb of the coupon-rule. coupon-rules can check whether the user or subscription has a certain property.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
16
|
+
**preposition** | **String** | { \"description\" : \"This is the comparison operator of the coupon-rule's parameter and the subject's object.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
17
|
+
**parameter** | **String** | { \"description\" : \"The parameter for the coupon-rule. This specifies the ID or the quantity for the object of the subject.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
18
|
+
**object** | **String** | { \"description\" : \"The property of the subject of the coupon-rule. e.g. When the subject is 'subscription' and the object is 'product-ID', the coupon-rule will observe the product-ID for that subscription.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
19
|
+
**rule_validation_strategy** | **String** | { \"description\" : \"The rule-validation-strategy object associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
20
|
+
**specifier** | **String** | { \"description\" : \"When the subject is subscription, the specifier is used to define which unit of measure the coupon rule will operate on. When the subject is user, the specifier defines which property of the user's account it will operate on.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
21
|
+
**deleted** | **BOOLEAN** | { \"description\" : \"Has the coupon-modifier been deleted.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } | [default to false]
|
|
22
|
+
**child_rules** | [**Array<CouponRule>**](CouponRule.md) | { \"description\" : \"The collection of child coupon-rules associated with the coupon-rule.\", \"verbs\":[\"POST\",\"PUT\",\"GET\"] } |
|
|
23
|
+
|
|
24
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# BillForward::CouponRulePagedMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**next_page** | **String** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
7
|
+
**current_page** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
8
|
+
**current_offset** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
9
|
+
**records_requested** | **Integer** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
10
|
+
**records_returned** | **Integer** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
11
|
+
**execution_time** | **Integer** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
12
|
+
**results** | [**Array<CouponRule>**](CouponRule.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# BillForward::CouponUniqueCodesRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
7
|
+
**changed_by** | **String** | { \"description\" : \"ID of the user who last updated the entity.\", \"verbs\":[] } | [optional]
|
|
8
|
+
**organization_id** | **String** | { \"description\" : \"\", \"verbs\":[\"POST\"] } |
|
|
9
|
+
**quantity** | **Integer** | { \"description\" : \"The number of unique codes that will be returned.\", \"verbs\":[\"POST\"] } |
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# BillForward::CouponUniqueCodesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**created** | **DateTime** | { \"description\" : \"The UTC DateTime when the object was created.\", \"verbs\":[] } | [optional]
|
|
7
|
+
**coupon_code** | **String** | { \"description\" : \"A unique code that can be applied to a subscription.\", \"verbs\":[\"POST\"] } | [optional]
|
|
8
|
+
**organization_id** | **String** | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# BillForward::CouponUniqueCodesResponsePagedMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**next_page** | **String** | {\"description\":\"Paging parameter. URL fragment that can be used to fetch next page of results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
7
|
+
**current_page** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes which page (given a page size of `recordsRequested`) of the result set you are viewing.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
8
|
+
**current_offset** | **Integer** | {\"description\":\"Paging parameter. 0-indexed. Describes your current location within a pageable list of query results.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
9
|
+
**records_requested** | **Integer** | {\"default\":10,\"description\":\"Paging parameter. Describes how many records you requested.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
10
|
+
**records_returned** | **Integer** | {\"description\":\"Describes how many records were returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
11
|
+
**execution_time** | **Integer** | {\"description\":\"Number of milliseconds taken by API to calculate response.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
12
|
+
**results** | [**Array<CouponUniqueCodesResponse>**](CouponUniqueCodesResponse.md) | {\"description\":\"The results returned by your query.\",\"verbs\":[\"GET\",\"PUT\",\"POST\"]} |
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# BillForward::CouponWrapperResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**coupon_code** | **String** | {\"description\":\"Code of the coupon applied.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
|
7
|
+
**discount** | **Float** | {\"description\":\"Discount &mdash; including tax &mdash; contributed to the cost of the pricing component, due to application of coupon.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
|
8
|
+
**discount_excluding_tax** | **Float** | {\"description\":\"Discount &mdash; excluding tax &mdash; contributed to the cost of the pricing component, due to application of coupon.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
|
9
|
+
**calculation** | **String** | {\"description\":\"Friendly text describing the calculation performed in applying the coupon.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
|
10
|
+
**pricing_component_name** | **String** | {\"description\":\"Name of the pricing component to whom the coupon was applied.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
|
11
|
+
**pricing_component_id** | **String** | {\"description\":\"ID of the pricing component to whom the coupon was applied.\",\"verbs\":[\"POST\",\"GET\"]} | [optional]
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,496 @@
|
|
|
1
|
+
# BillForward::CouponbookApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080/RestAPI*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_coupon_book**](CouponbookApi.md#create_coupon_book) | **POST** /coupon-books | Create a coupon-book.
|
|
8
|
+
[**delete_coupon_book**](CouponbookApi.md#delete_coupon_book) | **DELETE** /coupon-books/{coupon-book-ID} | Retire a coupon-book, specified by the coupon-book-ID parameter.
|
|
9
|
+
[**get_all_attachable_coupon_books**](CouponbookApi.md#get_all_attachable_coupon_books) | **GET** /coupon-books/attachable/{attachableness}/{has_code} | Returns a collection of attachable coupon-books. An attachable coupon-book has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order.
|
|
10
|
+
[**get_all_coupon_books**](CouponbookApi.md#get_all_coupon_books) | **GET** /coupon-books | Returns a collection of coupon-books. By default 10 values are returned. Records are returned in natural order.
|
|
11
|
+
[**get_coupon_book_by_book_code**](CouponbookApi.md#get_coupon_book_by_book_code) | **GET** /coupon-books/book-code/{book-code} | Returns a single coupon-book, specified by the book-code parameter.
|
|
12
|
+
[**get_coupon_book_by_coupon_book_definition_id**](CouponbookApi.md#get_coupon_book_by_coupon_book_definition_id) | **GET** /coupon-books/coupon-book-definition/{coupon-book-definition-ID} | Returns a collection of coupon-books, specified by coupon-book-definition-ID parameter. By default 10 coupon-books are returned. Records are returned in natural order.
|
|
13
|
+
[**get_coupon_book_by_coupon_code**](CouponbookApi.md#get_coupon_book_by_coupon_code) | **GET** /coupon-books/coupon/{coupon-code} | Returns a single coupon-book, specified by the coupon-code parameter.
|
|
14
|
+
[**get_coupon_book_by_id**](CouponbookApi.md#get_coupon_book_by_id) | **GET** /coupon-books/{coupon-book-ID} | Returns a single coupon-book, specified by the coupon-book-ID parameter.
|
|
15
|
+
[**update_coupon_book**](CouponbookApi.md#update_coupon_book) | **PUT** /coupon-books | Update a coupon-book.
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
# **create_coupon_book**
|
|
19
|
+
> CouponBookPagedMetadata create_coupon_book(coupon_book)
|
|
20
|
+
|
|
21
|
+
Create a coupon-book.
|
|
22
|
+
|
|
23
|
+
{\"nickname\":\"Create a new coupon book\",\"request\":\"createCouponBookRequest.html\",\"response\":\"createCouponBookResponse.html\"}
|
|
24
|
+
|
|
25
|
+
### Example
|
|
26
|
+
```ruby
|
|
27
|
+
# load the gem
|
|
28
|
+
require 'bf_ruby2'
|
|
29
|
+
|
|
30
|
+
api_instance = BillForward::CouponbookApi.new
|
|
31
|
+
|
|
32
|
+
coupon_book = BillForward::CouponBook.new # CouponBook | The coupon-book object to be created.
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
#Create a coupon-book.
|
|
37
|
+
result = api_instance.create_coupon_book(coupon_book)
|
|
38
|
+
p result
|
|
39
|
+
rescue BillForward::ApiError => e
|
|
40
|
+
puts "Exception when calling CouponbookApi->create_coupon_book: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Parameters
|
|
45
|
+
|
|
46
|
+
Name | Type | Description | Notes
|
|
47
|
+
------------- | ------------- | ------------- | -------------
|
|
48
|
+
**coupon_book** | [**CouponBook**](CouponBook.md)| The coupon-book object to be created. |
|
|
49
|
+
|
|
50
|
+
### Return type
|
|
51
|
+
|
|
52
|
+
[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md)
|
|
53
|
+
|
|
54
|
+
### Authorization
|
|
55
|
+
|
|
56
|
+
No authorization required
|
|
57
|
+
|
|
58
|
+
### HTTP request headers
|
|
59
|
+
|
|
60
|
+
- **Content-Type**: application/json
|
|
61
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
# **delete_coupon_book**
|
|
66
|
+
> CouponBookPagedMetadata delete_coupon_book(coupon_book_id, opts)
|
|
67
|
+
|
|
68
|
+
Retire a coupon-book, specified by the coupon-book-ID parameter.
|
|
69
|
+
|
|
70
|
+
{\"nickname\":\"Delete coupon book\",\"response\":\"deleteCouponBookByID.html\"}
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
```ruby
|
|
74
|
+
# load the gem
|
|
75
|
+
require 'bf_ruby2'
|
|
76
|
+
|
|
77
|
+
api_instance = BillForward::CouponbookApi.new
|
|
78
|
+
|
|
79
|
+
coupon_book_id = "coupon_book_id_example" # String | ID of the coupon-book.
|
|
80
|
+
|
|
81
|
+
opts = {
|
|
82
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
begin
|
|
86
|
+
#Retire a coupon-book, specified by the coupon-book-ID parameter.
|
|
87
|
+
result = api_instance.delete_coupon_book(coupon_book_id, opts)
|
|
88
|
+
p result
|
|
89
|
+
rescue BillForward::ApiError => e
|
|
90
|
+
puts "Exception when calling CouponbookApi->delete_coupon_book: #{e}"
|
|
91
|
+
end
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
Name | Type | Description | Notes
|
|
97
|
+
------------- | ------------- | ------------- | -------------
|
|
98
|
+
**coupon_book_id** | **String**| ID of the coupon-book. |
|
|
99
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
100
|
+
|
|
101
|
+
### Return type
|
|
102
|
+
|
|
103
|
+
[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md)
|
|
104
|
+
|
|
105
|
+
### Authorization
|
|
106
|
+
|
|
107
|
+
No authorization required
|
|
108
|
+
|
|
109
|
+
### HTTP request headers
|
|
110
|
+
|
|
111
|
+
- **Content-Type**: text/plain
|
|
112
|
+
- **Accept**: application/json
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
# **get_all_attachable_coupon_books**
|
|
117
|
+
> CouponBookPagedMetadata get_all_attachable_coupon_books(attachableness, has_code, opts)
|
|
118
|
+
|
|
119
|
+
Returns a collection of attachable coupon-books. An attachable coupon-book has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order.
|
|
120
|
+
|
|
121
|
+
{\"nickname\":\"Get all attachable coupon books\",\"response\":\"getCouponBookAllAttachable.html\"}
|
|
122
|
+
|
|
123
|
+
### Example
|
|
124
|
+
```ruby
|
|
125
|
+
# load the gem
|
|
126
|
+
require 'bf_ruby2'
|
|
127
|
+
|
|
128
|
+
api_instance = BillForward::CouponbookApi.new
|
|
129
|
+
|
|
130
|
+
attachableness = true # BOOLEAN | The attachableness of the coupon-book.
|
|
131
|
+
|
|
132
|
+
has_code = true # BOOLEAN | Whether the coupon-books have book codes or not.
|
|
133
|
+
|
|
134
|
+
opts = {
|
|
135
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
136
|
+
offset: 0, # Integer | The offset from the first coupon-book to return.
|
|
137
|
+
records: 10, # Integer | The maximum number of coupon-books to return.
|
|
138
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
139
|
+
order: "DESC" # String | Ihe direction of any ordering, either ASC or DESC.
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
begin
|
|
143
|
+
#Returns a collection of attachable coupon-books. An attachable coupon-book has at least one remaining use, and is not deleted. By default 10 values are returned. Records are returned in natural order.
|
|
144
|
+
result = api_instance.get_all_attachable_coupon_books(attachableness, has_code, opts)
|
|
145
|
+
p result
|
|
146
|
+
rescue BillForward::ApiError => e
|
|
147
|
+
puts "Exception when calling CouponbookApi->get_all_attachable_coupon_books: #{e}"
|
|
148
|
+
end
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Parameters
|
|
152
|
+
|
|
153
|
+
Name | Type | Description | Notes
|
|
154
|
+
------------- | ------------- | ------------- | -------------
|
|
155
|
+
**attachableness** | **BOOLEAN**| The attachableness of the coupon-book. |
|
|
156
|
+
**has_code** | **BOOLEAN**| Whether the coupon-books have book codes or not. |
|
|
157
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
158
|
+
**offset** | **Integer**| The offset from the first coupon-book to return. | [optional] [default to 0]
|
|
159
|
+
**records** | **Integer**| The maximum number of coupon-books to return. | [optional] [default to 10]
|
|
160
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
161
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
162
|
+
|
|
163
|
+
### Return type
|
|
164
|
+
|
|
165
|
+
[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md)
|
|
166
|
+
|
|
167
|
+
### Authorization
|
|
168
|
+
|
|
169
|
+
No authorization required
|
|
170
|
+
|
|
171
|
+
### HTTP request headers
|
|
172
|
+
|
|
173
|
+
- **Content-Type**: Not defined
|
|
174
|
+
- **Accept**: application/json
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
# **get_all_coupon_books**
|
|
179
|
+
> CouponBookPagedMetadata get_all_coupon_books(opts)
|
|
180
|
+
|
|
181
|
+
Returns a collection of coupon-books. By default 10 values are returned. Records are returned in natural order.
|
|
182
|
+
|
|
183
|
+
{\"nickname\":\"Get all coupon books\",\"response\":\"getCouponBookAll.html\"}
|
|
184
|
+
|
|
185
|
+
### Example
|
|
186
|
+
```ruby
|
|
187
|
+
# load the gem
|
|
188
|
+
require 'bf_ruby2'
|
|
189
|
+
|
|
190
|
+
api_instance = BillForward::CouponbookApi.new
|
|
191
|
+
|
|
192
|
+
opts = {
|
|
193
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
194
|
+
offset: 0, # Integer | The offset from the first coupon-books to return.
|
|
195
|
+
records: 10, # Integer | The maximum number of coupon-books to return.
|
|
196
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
197
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
198
|
+
include_retired: true # BOOLEAN | Whether retired coupon-books should be returned.
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
begin
|
|
202
|
+
#Returns a collection of coupon-books. By default 10 values are returned. Records are returned in natural order.
|
|
203
|
+
result = api_instance.get_all_coupon_books(opts)
|
|
204
|
+
p result
|
|
205
|
+
rescue BillForward::ApiError => e
|
|
206
|
+
puts "Exception when calling CouponbookApi->get_all_coupon_books: #{e}"
|
|
207
|
+
end
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Parameters
|
|
211
|
+
|
|
212
|
+
Name | Type | Description | Notes
|
|
213
|
+
------------- | ------------- | ------------- | -------------
|
|
214
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
215
|
+
**offset** | **Integer**| The offset from the first coupon-books to return. | [optional] [default to 0]
|
|
216
|
+
**records** | **Integer**| The maximum number of coupon-books to return. | [optional] [default to 10]
|
|
217
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
218
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
219
|
+
**include_retired** | **BOOLEAN**| Whether retired coupon-books should be returned. | [optional] [default to true]
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md)
|
|
224
|
+
|
|
225
|
+
### Authorization
|
|
226
|
+
|
|
227
|
+
No authorization required
|
|
228
|
+
|
|
229
|
+
### HTTP request headers
|
|
230
|
+
|
|
231
|
+
- **Content-Type**: Not defined
|
|
232
|
+
- **Accept**: application/json
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
# **get_coupon_book_by_book_code**
|
|
237
|
+
> CouponBookPagedMetadata get_coupon_book_by_book_code(book_code, opts)
|
|
238
|
+
|
|
239
|
+
Returns a single coupon-book, specified by the book-code parameter.
|
|
240
|
+
|
|
241
|
+
{\"nickname\":\"Retrieve by book code\",\"response\":\"getCouponBookByBookCode.html\"}
|
|
242
|
+
|
|
243
|
+
### Example
|
|
244
|
+
```ruby
|
|
245
|
+
# load the gem
|
|
246
|
+
require 'bf_ruby2'
|
|
247
|
+
|
|
248
|
+
api_instance = BillForward::CouponbookApi.new
|
|
249
|
+
|
|
250
|
+
book_code = "book_code_example" # String | The unique coupon-book-code.
|
|
251
|
+
|
|
252
|
+
opts = {
|
|
253
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
begin
|
|
257
|
+
#Returns a single coupon-book, specified by the book-code parameter.
|
|
258
|
+
result = api_instance.get_coupon_book_by_book_code(book_code, opts)
|
|
259
|
+
p result
|
|
260
|
+
rescue BillForward::ApiError => e
|
|
261
|
+
puts "Exception when calling CouponbookApi->get_coupon_book_by_book_code: #{e}"
|
|
262
|
+
end
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### Parameters
|
|
266
|
+
|
|
267
|
+
Name | Type | Description | Notes
|
|
268
|
+
------------- | ------------- | ------------- | -------------
|
|
269
|
+
**book_code** | **String**| The unique coupon-book-code. |
|
|
270
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
271
|
+
|
|
272
|
+
### Return type
|
|
273
|
+
|
|
274
|
+
[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md)
|
|
275
|
+
|
|
276
|
+
### Authorization
|
|
277
|
+
|
|
278
|
+
No authorization required
|
|
279
|
+
|
|
280
|
+
### HTTP request headers
|
|
281
|
+
|
|
282
|
+
- **Content-Type**: text/plain
|
|
283
|
+
- **Accept**: application/json
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
# **get_coupon_book_by_coupon_book_definition_id**
|
|
288
|
+
> CouponBookPagedMetadata get_coupon_book_by_coupon_book_definition_id(coupon_book_definition_id, opts)
|
|
289
|
+
|
|
290
|
+
Returns a collection of coupon-books, specified by coupon-book-definition-ID parameter. By default 10 coupon-books are returned. Records are returned in natural order.
|
|
291
|
+
|
|
292
|
+
{\"nickname\":\"Retrieve by coupon book definition\",\"response\":\"getCouponBookByCouponBookDefinitionID.html\"}
|
|
293
|
+
|
|
294
|
+
### Example
|
|
295
|
+
```ruby
|
|
296
|
+
# load the gem
|
|
297
|
+
require 'bf_ruby2'
|
|
298
|
+
|
|
299
|
+
api_instance = BillForward::CouponbookApi.new
|
|
300
|
+
|
|
301
|
+
coupon_book_definition_id = "coupon_book_definition_id_example" # String | The string coupon-book-definition-ID of the coupon-book.
|
|
302
|
+
|
|
303
|
+
opts = {
|
|
304
|
+
organizations: ["organizations_example"], # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
305
|
+
offset: 0, # Integer | The offset from the first coupon-book to return.
|
|
306
|
+
records: 10, # Integer | The maximum number of coupon-books to return.
|
|
307
|
+
order_by: "created", # String | Specify a field used to order the result set.
|
|
308
|
+
order: "DESC", # String | Ihe direction of any ordering, either ASC or DESC.
|
|
309
|
+
include_retired: true # BOOLEAN | Whether retired coupon-books should be returned.
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
begin
|
|
313
|
+
#Returns a collection of coupon-books, specified by coupon-book-definition-ID parameter. By default 10 coupon-books are returned. Records are returned in natural order.
|
|
314
|
+
result = api_instance.get_coupon_book_by_coupon_book_definition_id(coupon_book_definition_id, opts)
|
|
315
|
+
p result
|
|
316
|
+
rescue BillForward::ApiError => e
|
|
317
|
+
puts "Exception when calling CouponbookApi->get_coupon_book_by_coupon_book_definition_id: #{e}"
|
|
318
|
+
end
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
### Parameters
|
|
322
|
+
|
|
323
|
+
Name | Type | Description | Notes
|
|
324
|
+
------------- | ------------- | ------------- | -------------
|
|
325
|
+
**coupon_book_definition_id** | **String**| The string coupon-book-definition-ID of the coupon-book. |
|
|
326
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
327
|
+
**offset** | **Integer**| The offset from the first coupon-book to return. | [optional] [default to 0]
|
|
328
|
+
**records** | **Integer**| The maximum number of coupon-books to return. | [optional] [default to 10]
|
|
329
|
+
**order_by** | **String**| Specify a field used to order the result set. | [optional] [default to created]
|
|
330
|
+
**order** | **String**| Ihe direction of any ordering, either ASC or DESC. | [optional] [default to DESC]
|
|
331
|
+
**include_retired** | **BOOLEAN**| Whether retired coupon-books should be returned. | [optional] [default to true]
|
|
332
|
+
|
|
333
|
+
### Return type
|
|
334
|
+
|
|
335
|
+
[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md)
|
|
336
|
+
|
|
337
|
+
### Authorization
|
|
338
|
+
|
|
339
|
+
No authorization required
|
|
340
|
+
|
|
341
|
+
### HTTP request headers
|
|
342
|
+
|
|
343
|
+
- **Content-Type**: text/plain
|
|
344
|
+
- **Accept**: application/json
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
# **get_coupon_book_by_coupon_code**
|
|
349
|
+
> CouponBookPagedMetadata get_coupon_book_by_coupon_code(coupon_code, opts)
|
|
350
|
+
|
|
351
|
+
Returns a single coupon-book, specified by the coupon-code parameter.
|
|
352
|
+
|
|
353
|
+
{\"nickname\":\"Retrieve by coupon code\",\"response\":\"getCouponBookByBookCode.html\"}
|
|
354
|
+
|
|
355
|
+
### Example
|
|
356
|
+
```ruby
|
|
357
|
+
# load the gem
|
|
358
|
+
require 'bf_ruby2'
|
|
359
|
+
|
|
360
|
+
api_instance = BillForward::CouponbookApi.new
|
|
361
|
+
|
|
362
|
+
coupon_code = "coupon_code_example" # String | The unique coupon-code.
|
|
363
|
+
|
|
364
|
+
opts = {
|
|
365
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
366
|
+
}
|
|
367
|
+
|
|
368
|
+
begin
|
|
369
|
+
#Returns a single coupon-book, specified by the coupon-code parameter.
|
|
370
|
+
result = api_instance.get_coupon_book_by_coupon_code(coupon_code, opts)
|
|
371
|
+
p result
|
|
372
|
+
rescue BillForward::ApiError => e
|
|
373
|
+
puts "Exception when calling CouponbookApi->get_coupon_book_by_coupon_code: #{e}"
|
|
374
|
+
end
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### Parameters
|
|
378
|
+
|
|
379
|
+
Name | Type | Description | Notes
|
|
380
|
+
------------- | ------------- | ------------- | -------------
|
|
381
|
+
**coupon_code** | **String**| The unique coupon-code. |
|
|
382
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
383
|
+
|
|
384
|
+
### Return type
|
|
385
|
+
|
|
386
|
+
[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md)
|
|
387
|
+
|
|
388
|
+
### Authorization
|
|
389
|
+
|
|
390
|
+
No authorization required
|
|
391
|
+
|
|
392
|
+
### HTTP request headers
|
|
393
|
+
|
|
394
|
+
- **Content-Type**: text/plain
|
|
395
|
+
- **Accept**: application/json
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
# **get_coupon_book_by_id**
|
|
400
|
+
> CouponBookPagedMetadata get_coupon_book_by_id(coupon_book_id, opts)
|
|
401
|
+
|
|
402
|
+
Returns a single coupon-book, specified by the coupon-book-ID parameter.
|
|
403
|
+
|
|
404
|
+
{\"nickname\":\"Retrieve an existing coupon book\",\"response\":\"getCouponBookByID.html\"}
|
|
405
|
+
|
|
406
|
+
### Example
|
|
407
|
+
```ruby
|
|
408
|
+
# load the gem
|
|
409
|
+
require 'bf_ruby2'
|
|
410
|
+
|
|
411
|
+
api_instance = BillForward::CouponbookApi.new
|
|
412
|
+
|
|
413
|
+
coupon_book_id = "coupon_book_id_example" # String | ID of the coupon-book.
|
|
414
|
+
|
|
415
|
+
opts = {
|
|
416
|
+
organizations: ["organizations_example"] # Array<String> | A list of organization-IDs used to restrict the scope of API calls.
|
|
417
|
+
}
|
|
418
|
+
|
|
419
|
+
begin
|
|
420
|
+
#Returns a single coupon-book, specified by the coupon-book-ID parameter.
|
|
421
|
+
result = api_instance.get_coupon_book_by_id(coupon_book_id, opts)
|
|
422
|
+
p result
|
|
423
|
+
rescue BillForward::ApiError => e
|
|
424
|
+
puts "Exception when calling CouponbookApi->get_coupon_book_by_id: #{e}"
|
|
425
|
+
end
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
### Parameters
|
|
429
|
+
|
|
430
|
+
Name | Type | Description | Notes
|
|
431
|
+
------------- | ------------- | ------------- | -------------
|
|
432
|
+
**coupon_book_id** | **String**| ID of the coupon-book. |
|
|
433
|
+
**organizations** | [**Array<String>**](String.md)| A list of organization-IDs used to restrict the scope of API calls. | [optional]
|
|
434
|
+
|
|
435
|
+
### Return type
|
|
436
|
+
|
|
437
|
+
[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md)
|
|
438
|
+
|
|
439
|
+
### Authorization
|
|
440
|
+
|
|
441
|
+
No authorization required
|
|
442
|
+
|
|
443
|
+
### HTTP request headers
|
|
444
|
+
|
|
445
|
+
- **Content-Type**: text/plain
|
|
446
|
+
- **Accept**: application/json
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
# **update_coupon_book**
|
|
451
|
+
> CouponBookPagedMetadata update_coupon_book(coupon_book)
|
|
452
|
+
|
|
453
|
+
Update a coupon-book.
|
|
454
|
+
|
|
455
|
+
{\"nickname\":\"Update a coupon book\",\"request\":\"updateCouponBookRequest.html\",\"response\":\"updateCouponBookResponse.html\"}
|
|
456
|
+
|
|
457
|
+
### Example
|
|
458
|
+
```ruby
|
|
459
|
+
# load the gem
|
|
460
|
+
require 'bf_ruby2'
|
|
461
|
+
|
|
462
|
+
api_instance = BillForward::CouponbookApi.new
|
|
463
|
+
|
|
464
|
+
coupon_book = BillForward::CouponBook.new # CouponBook | The coupon-book object to be updated.
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
begin
|
|
468
|
+
#Update a coupon-book.
|
|
469
|
+
result = api_instance.update_coupon_book(coupon_book)
|
|
470
|
+
p result
|
|
471
|
+
rescue BillForward::ApiError => e
|
|
472
|
+
puts "Exception when calling CouponbookApi->update_coupon_book: #{e}"
|
|
473
|
+
end
|
|
474
|
+
```
|
|
475
|
+
|
|
476
|
+
### Parameters
|
|
477
|
+
|
|
478
|
+
Name | Type | Description | Notes
|
|
479
|
+
------------- | ------------- | ------------- | -------------
|
|
480
|
+
**coupon_book** | [**CouponBook**](CouponBook.md)| The coupon-book object to be updated. |
|
|
481
|
+
|
|
482
|
+
### Return type
|
|
483
|
+
|
|
484
|
+
[**CouponBookPagedMetadata**](CouponBookPagedMetadata.md)
|
|
485
|
+
|
|
486
|
+
### Authorization
|
|
487
|
+
|
|
488
|
+
No authorization required
|
|
489
|
+
|
|
490
|
+
### HTTP request headers
|
|
491
|
+
|
|
492
|
+
- **Content-Type**: application/json
|
|
493
|
+
- **Accept**: text/xml, application/xml, application/json
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|