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
@@ -0,0 +1,1257 @@
|
|
1
|
+
=begin
|
2
|
+
#BillForward REST API
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
11
|
+
you may not use this file except in compliance with the License.
|
12
|
+
You may obtain a copy of the License at
|
13
|
+
|
14
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
15
|
+
|
16
|
+
Unless required by applicable law or agreed to in writing, software
|
17
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
18
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
19
|
+
See the License for the specific language governing permissions and
|
20
|
+
limitations under the License.
|
21
|
+
|
22
|
+
=end
|
23
|
+
|
24
|
+
require "uri"
|
25
|
+
|
26
|
+
module BillForward
|
27
|
+
class AccountsApi
|
28
|
+
attr_accessor :api_client
|
29
|
+
|
30
|
+
def initialize(api_client = ApiClient.default)
|
31
|
+
@api_client = api_client
|
32
|
+
end
|
33
|
+
|
34
|
+
# Creates a credit-note which may be used by any subscription of this account.
|
35
|
+
# {\"nickname\":\"Add Credit\",\"request\":\"addCreditNoteToAccountRequest.html\", \"response\":\"addCreditNoteToAccount.html\"}
|
36
|
+
# @param account_id ID of the account.
|
37
|
+
# @param credit_note The credit-note request
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [CreditNotePagedMetadata]
|
40
|
+
def add_credit_note_to_account(account_id, credit_note, opts = {})
|
41
|
+
data, _status_code, _headers = add_credit_note_to_account_with_http_info(account_id, credit_note, opts)
|
42
|
+
return data
|
43
|
+
end
|
44
|
+
|
45
|
+
# Creates a credit-note which may be used by any subscription of this account.
|
46
|
+
# {\"nickname\":\"Add Credit\",\"request\":\"addCreditNoteToAccountRequest.html\", \"response\":\"addCreditNoteToAccount.html\"}
|
47
|
+
# @param account_id ID of the account.
|
48
|
+
# @param credit_note The credit-note request
|
49
|
+
# @param [Hash] opts the optional parameters
|
50
|
+
# @return [Array<(CreditNotePagedMetadata, Fixnum, Hash)>] CreditNotePagedMetadata data, response status code and response headers
|
51
|
+
def add_credit_note_to_account_with_http_info(account_id, credit_note, opts = {})
|
52
|
+
if @api_client.config.debugging
|
53
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.add_credit_note_to_account ..."
|
54
|
+
end
|
55
|
+
# verify the required parameter 'account_id' is set
|
56
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.add_credit_note_to_account" if account_id.nil?
|
57
|
+
# verify the required parameter 'credit_note' is set
|
58
|
+
fail ArgumentError, "Missing the required parameter 'credit_note' when calling AccountsApi.add_credit_note_to_account" if credit_note.nil?
|
59
|
+
# resource path
|
60
|
+
local_var_path = "/accounts/{account-ID}/credit".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s)
|
61
|
+
|
62
|
+
# query parameters
|
63
|
+
query_params = {}
|
64
|
+
|
65
|
+
# header parameters
|
66
|
+
header_params = {}
|
67
|
+
|
68
|
+
# HTTP header 'Accept' (if needed)
|
69
|
+
local_header_accept = ['application/json']
|
70
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
71
|
+
|
72
|
+
# HTTP header 'Content-Type'
|
73
|
+
local_header_content_type = ['application/json']
|
74
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
75
|
+
|
76
|
+
# form parameters
|
77
|
+
form_params = {}
|
78
|
+
|
79
|
+
# http body (model)
|
80
|
+
post_body = @api_client.object_to_http_body(credit_note)
|
81
|
+
auth_names = []
|
82
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
83
|
+
:header_params => header_params,
|
84
|
+
:query_params => query_params,
|
85
|
+
:form_params => form_params,
|
86
|
+
:body => post_body,
|
87
|
+
:auth_names => auth_names,
|
88
|
+
:return_type => 'CreditNotePagedMetadata')
|
89
|
+
if @api_client.config.debugging
|
90
|
+
@api_client.config.logger.debug "API called: AccountsApi#add_credit_note_to_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
91
|
+
end
|
92
|
+
return data, status_code, headers
|
93
|
+
end
|
94
|
+
|
95
|
+
# Add a role to the account
|
96
|
+
# {\"nickname\":\"Add Role\",\"response\":\"addRoleToAccountResponse.html\",\"request\":\"addRoleToAccountRequest.html\"}
|
97
|
+
# @param account_id ID of the account.
|
98
|
+
# @param role ID or name of the role.
|
99
|
+
# @param [Hash] opts the optional parameters
|
100
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
101
|
+
# @return [RolePagedMetadata]
|
102
|
+
def add_permission_to_account(account_id, role, opts = {})
|
103
|
+
data, _status_code, _headers = add_permission_to_account_with_http_info(account_id, role, opts)
|
104
|
+
return data
|
105
|
+
end
|
106
|
+
|
107
|
+
# Add a role to the account
|
108
|
+
# {\"nickname\":\"Add Role\",\"response\":\"addRoleToAccountResponse.html\",\"request\":\"addRoleToAccountRequest.html\"}
|
109
|
+
# @param account_id ID of the account.
|
110
|
+
# @param role ID or name of the role.
|
111
|
+
# @param [Hash] opts the optional parameters
|
112
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
113
|
+
# @return [Array<(RolePagedMetadata, Fixnum, Hash)>] RolePagedMetadata data, response status code and response headers
|
114
|
+
def add_permission_to_account_with_http_info(account_id, role, opts = {})
|
115
|
+
if @api_client.config.debugging
|
116
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.add_permission_to_account ..."
|
117
|
+
end
|
118
|
+
# verify the required parameter 'account_id' is set
|
119
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.add_permission_to_account" if account_id.nil?
|
120
|
+
# verify the required parameter 'role' is set
|
121
|
+
fail ArgumentError, "Missing the required parameter 'role' when calling AccountsApi.add_permission_to_account" if role.nil?
|
122
|
+
# resource path
|
123
|
+
local_var_path = "/accounts/{account-ID}/roles/{role}".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s).sub('{' + 'role' + '}', role.to_s)
|
124
|
+
|
125
|
+
# query parameters
|
126
|
+
query_params = {}
|
127
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
128
|
+
|
129
|
+
# header parameters
|
130
|
+
header_params = {}
|
131
|
+
|
132
|
+
# HTTP header 'Accept' (if needed)
|
133
|
+
local_header_accept = ['application/json']
|
134
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
135
|
+
|
136
|
+
# HTTP header 'Content-Type'
|
137
|
+
local_header_content_type = ['application/json']
|
138
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
139
|
+
|
140
|
+
# form parameters
|
141
|
+
form_params = {}
|
142
|
+
|
143
|
+
# http body (model)
|
144
|
+
post_body = nil
|
145
|
+
auth_names = []
|
146
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
147
|
+
:header_params => header_params,
|
148
|
+
:query_params => query_params,
|
149
|
+
:form_params => form_params,
|
150
|
+
:body => post_body,
|
151
|
+
:auth_names => auth_names,
|
152
|
+
:return_type => 'RolePagedMetadata')
|
153
|
+
if @api_client.config.debugging
|
154
|
+
@api_client.config.logger.debug "API called: AccountsApi#add_permission_to_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
155
|
+
end
|
156
|
+
return data, status_code, headers
|
157
|
+
end
|
158
|
+
|
159
|
+
# Create an Account.
|
160
|
+
# {\"nickname\":\"Create a new account\",\"response\":\"createAccountResponse.html\",\"request\":\"createAccountRequest.html\"}
|
161
|
+
# @param request The account object to be created.
|
162
|
+
# @param [Hash] opts the optional parameters
|
163
|
+
# @return [AccountPagedMetadata]
|
164
|
+
def create_account(request, opts = {})
|
165
|
+
data, _status_code, _headers = create_account_with_http_info(request, opts)
|
166
|
+
return data
|
167
|
+
end
|
168
|
+
|
169
|
+
# Create an Account.
|
170
|
+
# {\"nickname\":\"Create a new account\",\"response\":\"createAccountResponse.html\",\"request\":\"createAccountRequest.html\"}
|
171
|
+
# @param request The account object to be created.
|
172
|
+
# @param [Hash] opts the optional parameters
|
173
|
+
# @return [Array<(AccountPagedMetadata, Fixnum, Hash)>] AccountPagedMetadata data, response status code and response headers
|
174
|
+
def create_account_with_http_info(request, opts = {})
|
175
|
+
if @api_client.config.debugging
|
176
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.create_account ..."
|
177
|
+
end
|
178
|
+
# verify the required parameter 'request' is set
|
179
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling AccountsApi.create_account" if request.nil?
|
180
|
+
# resource path
|
181
|
+
local_var_path = "/accounts".sub('{format}','json')
|
182
|
+
|
183
|
+
# query parameters
|
184
|
+
query_params = {}
|
185
|
+
|
186
|
+
# header parameters
|
187
|
+
header_params = {}
|
188
|
+
|
189
|
+
# HTTP header 'Accept' (if needed)
|
190
|
+
local_header_accept = ['text/xml', 'application/xml', 'application/json']
|
191
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
192
|
+
|
193
|
+
# HTTP header 'Content-Type'
|
194
|
+
local_header_content_type = ['application/json']
|
195
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
196
|
+
|
197
|
+
# form parameters
|
198
|
+
form_params = {}
|
199
|
+
|
200
|
+
# http body (model)
|
201
|
+
post_body = @api_client.object_to_http_body(request)
|
202
|
+
auth_names = []
|
203
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
204
|
+
:header_params => header_params,
|
205
|
+
:query_params => query_params,
|
206
|
+
:form_params => form_params,
|
207
|
+
:body => post_body,
|
208
|
+
:auth_names => auth_names,
|
209
|
+
:return_type => 'AccountPagedMetadata')
|
210
|
+
if @api_client.config.debugging
|
211
|
+
@api_client.config.logger.debug "API called: AccountsApi#create_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
212
|
+
end
|
213
|
+
return data, status_code, headers
|
214
|
+
end
|
215
|
+
|
216
|
+
# Delete the account specified by the account-ID parameter.
|
217
|
+
# {\"nickname\":\"Retire\",\"response\":\"deleteAccount.html\"}
|
218
|
+
# @param account_id
|
219
|
+
# @param delete_gateway_data
|
220
|
+
# @param organizations A list of organization-IDs used to restrict the scope of API calls.
|
221
|
+
# @param [Hash] opts the optional parameters
|
222
|
+
# @return [AccountPagedMetadata]
|
223
|
+
def delete_account(account_id, delete_gateway_data, organizations, opts = {})
|
224
|
+
data, _status_code, _headers = delete_account_with_http_info(account_id, delete_gateway_data, organizations, opts)
|
225
|
+
return data
|
226
|
+
end
|
227
|
+
|
228
|
+
# Delete the account specified by the account-ID parameter.
|
229
|
+
# {\"nickname\":\"Retire\",\"response\":\"deleteAccount.html\"}
|
230
|
+
# @param account_id
|
231
|
+
# @param delete_gateway_data
|
232
|
+
# @param organizations A list of organization-IDs used to restrict the scope of API calls.
|
233
|
+
# @param [Hash] opts the optional parameters
|
234
|
+
# @return [Array<(AccountPagedMetadata, Fixnum, Hash)>] AccountPagedMetadata data, response status code and response headers
|
235
|
+
def delete_account_with_http_info(account_id, delete_gateway_data, organizations, opts = {})
|
236
|
+
if @api_client.config.debugging
|
237
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete_account ..."
|
238
|
+
end
|
239
|
+
# verify the required parameter 'account_id' is set
|
240
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_account" if account_id.nil?
|
241
|
+
# verify the required parameter 'delete_gateway_data' is set
|
242
|
+
fail ArgumentError, "Missing the required parameter 'delete_gateway_data' when calling AccountsApi.delete_account" if delete_gateway_data.nil?
|
243
|
+
# verify the required parameter 'organizations' is set
|
244
|
+
fail ArgumentError, "Missing the required parameter 'organizations' when calling AccountsApi.delete_account" if organizations.nil?
|
245
|
+
# resource path
|
246
|
+
local_var_path = "/accounts/{account-ID}".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s)
|
247
|
+
|
248
|
+
# query parameters
|
249
|
+
query_params = {}
|
250
|
+
query_params[:'delete_gateway_data'] = delete_gateway_data
|
251
|
+
query_params[:'organizations'] = @api_client.build_collection_param(organizations, :multi)
|
252
|
+
|
253
|
+
# header parameters
|
254
|
+
header_params = {}
|
255
|
+
|
256
|
+
# HTTP header 'Accept' (if needed)
|
257
|
+
local_header_accept = ['application/json']
|
258
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
259
|
+
|
260
|
+
# HTTP header 'Content-Type'
|
261
|
+
local_header_content_type = ['text/plain', 'application/json']
|
262
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
263
|
+
|
264
|
+
# form parameters
|
265
|
+
form_params = {}
|
266
|
+
|
267
|
+
# http body (model)
|
268
|
+
post_body = nil
|
269
|
+
auth_names = []
|
270
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
271
|
+
:header_params => header_params,
|
272
|
+
:query_params => query_params,
|
273
|
+
:form_params => form_params,
|
274
|
+
:body => post_body,
|
275
|
+
:auth_names => auth_names,
|
276
|
+
:return_type => 'AccountPagedMetadata')
|
277
|
+
if @api_client.config.debugging
|
278
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
279
|
+
end
|
280
|
+
return data, status_code, headers
|
281
|
+
end
|
282
|
+
|
283
|
+
# Remove any associated metadata.
|
284
|
+
# {\"nickname\":\"Clear metadata from account\",\"request\" :\"deleteAccountMetadataRequest.html\",\"response\":\"deleteAccountMetadataResponse.html\"}
|
285
|
+
# @param account_id
|
286
|
+
# @param [Hash] opts the optional parameters
|
287
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
288
|
+
# @return [DynamicMetadata]
|
289
|
+
def delete_metadata_for_account(account_id, opts = {})
|
290
|
+
data, _status_code, _headers = delete_metadata_for_account_with_http_info(account_id, opts)
|
291
|
+
return data
|
292
|
+
end
|
293
|
+
|
294
|
+
# Remove any associated metadata.
|
295
|
+
# {\"nickname\":\"Clear metadata from account\",\"request\" :\"deleteAccountMetadataRequest.html\",\"response\":\"deleteAccountMetadataResponse.html\"}
|
296
|
+
# @param account_id
|
297
|
+
# @param [Hash] opts the optional parameters
|
298
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
299
|
+
# @return [Array<(DynamicMetadata, Fixnum, Hash)>] DynamicMetadata data, response status code and response headers
|
300
|
+
def delete_metadata_for_account_with_http_info(account_id, opts = {})
|
301
|
+
if @api_client.config.debugging
|
302
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.delete_metadata_for_account ..."
|
303
|
+
end
|
304
|
+
# verify the required parameter 'account_id' is set
|
305
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.delete_metadata_for_account" if account_id.nil?
|
306
|
+
# resource path
|
307
|
+
local_var_path = "/accounts/{account-ID}/metadata".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s)
|
308
|
+
|
309
|
+
# query parameters
|
310
|
+
query_params = {}
|
311
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
312
|
+
|
313
|
+
# header parameters
|
314
|
+
header_params = {}
|
315
|
+
|
316
|
+
# HTTP header 'Accept' (if needed)
|
317
|
+
local_header_accept = ['application/json']
|
318
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
319
|
+
|
320
|
+
# HTTP header 'Content-Type'
|
321
|
+
local_header_content_type = ['text/plain', 'application/json']
|
322
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
323
|
+
|
324
|
+
# form parameters
|
325
|
+
form_params = {}
|
326
|
+
|
327
|
+
# http body (model)
|
328
|
+
post_body = nil
|
329
|
+
auth_names = []
|
330
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
331
|
+
:header_params => header_params,
|
332
|
+
:query_params => query_params,
|
333
|
+
:form_params => form_params,
|
334
|
+
:body => post_body,
|
335
|
+
:auth_names => auth_names,
|
336
|
+
:return_type => 'DynamicMetadata')
|
337
|
+
if @api_client.config.debugging
|
338
|
+
@api_client.config.logger.debug "API called: AccountsApi#delete_metadata_for_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
339
|
+
end
|
340
|
+
return data, status_code, headers
|
341
|
+
end
|
342
|
+
|
343
|
+
# Returns a single account, specified by the account-ID parameter.
|
344
|
+
# {\"nickname\":\"Retrieve an existing account\",\"response\":\"getAccountByID.html\"}
|
345
|
+
# @param account_id
|
346
|
+
# @param [Hash] opts the optional parameters
|
347
|
+
# @option opts [Array<String>] :organizations
|
348
|
+
# @return [AccountPagedMetadata]
|
349
|
+
def get_account_by_id(account_id, opts = {})
|
350
|
+
data, _status_code, _headers = get_account_by_id_with_http_info(account_id, opts)
|
351
|
+
return data
|
352
|
+
end
|
353
|
+
|
354
|
+
# Returns a single account, specified by the account-ID parameter.
|
355
|
+
# {\"nickname\":\"Retrieve an existing account\",\"response\":\"getAccountByID.html\"}
|
356
|
+
# @param account_id
|
357
|
+
# @param [Hash] opts the optional parameters
|
358
|
+
# @option opts [Array<String>] :organizations
|
359
|
+
# @return [Array<(AccountPagedMetadata, Fixnum, Hash)>] AccountPagedMetadata data, response status code and response headers
|
360
|
+
def get_account_by_id_with_http_info(account_id, opts = {})
|
361
|
+
if @api_client.config.debugging
|
362
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_account_by_id ..."
|
363
|
+
end
|
364
|
+
# verify the required parameter 'account_id' is set
|
365
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account_by_id" if account_id.nil?
|
366
|
+
# resource path
|
367
|
+
local_var_path = "/accounts/{account-ID}".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s)
|
368
|
+
|
369
|
+
# query parameters
|
370
|
+
query_params = {}
|
371
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
372
|
+
|
373
|
+
# header parameters
|
374
|
+
header_params = {}
|
375
|
+
|
376
|
+
# HTTP header 'Accept' (if needed)
|
377
|
+
local_header_accept = ['application/json']
|
378
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
379
|
+
|
380
|
+
# HTTP header 'Content-Type'
|
381
|
+
local_header_content_type = ['text/plain', 'application/json']
|
382
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
383
|
+
|
384
|
+
# form parameters
|
385
|
+
form_params = {}
|
386
|
+
|
387
|
+
# http body (model)
|
388
|
+
post_body = nil
|
389
|
+
auth_names = []
|
390
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
391
|
+
:header_params => header_params,
|
392
|
+
:query_params => query_params,
|
393
|
+
:form_params => form_params,
|
394
|
+
:body => post_body,
|
395
|
+
:auth_names => auth_names,
|
396
|
+
:return_type => 'AccountPagedMetadata')
|
397
|
+
if @api_client.config.debugging
|
398
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_account_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
399
|
+
end
|
400
|
+
return data, status_code, headers
|
401
|
+
end
|
402
|
+
|
403
|
+
# Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
404
|
+
# {\"nickname\":\"Retrieve by creation\",\"response\":\"getAccountByCreated.html\"}
|
405
|
+
# @param lower_threshold The UTC DateTime specifying the start of the result period.
|
406
|
+
# @param upper_threshold The UTC DateTime specifying the end of the result period.
|
407
|
+
# @param [Hash] opts the optional parameters
|
408
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
409
|
+
# @option opts [Integer] :offset The offset from the first taxation-link to return. (default to 0)
|
410
|
+
# @option opts [Integer] :records The maximum number of taxation-links to return. (default to 10)
|
411
|
+
# @option opts [String] :order_by Specify a field used to order the result set. (default to created)
|
412
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
|
413
|
+
# @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to true)
|
414
|
+
# @return [AccountPagedMetadata]
|
415
|
+
def get_accounts_by_created(lower_threshold, upper_threshold, opts = {})
|
416
|
+
data, _status_code, _headers = get_accounts_by_created_with_http_info(lower_threshold, upper_threshold, opts)
|
417
|
+
return data
|
418
|
+
end
|
419
|
+
|
420
|
+
# Returns a collection of account objects with created times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
421
|
+
# {\"nickname\":\"Retrieve by creation\",\"response\":\"getAccountByCreated.html\"}
|
422
|
+
# @param lower_threshold The UTC DateTime specifying the start of the result period.
|
423
|
+
# @param upper_threshold The UTC DateTime specifying the end of the result period.
|
424
|
+
# @param [Hash] opts the optional parameters
|
425
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
426
|
+
# @option opts [Integer] :offset The offset from the first taxation-link to return.
|
427
|
+
# @option opts [Integer] :records The maximum number of taxation-links to return.
|
428
|
+
# @option opts [String] :order_by Specify a field used to order the result set.
|
429
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
|
430
|
+
# @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
|
431
|
+
# @return [Array<(AccountPagedMetadata, Fixnum, Hash)>] AccountPagedMetadata data, response status code and response headers
|
432
|
+
def get_accounts_by_created_with_http_info(lower_threshold, upper_threshold, opts = {})
|
433
|
+
if @api_client.config.debugging
|
434
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_accounts_by_created ..."
|
435
|
+
end
|
436
|
+
# verify the required parameter 'lower_threshold' is set
|
437
|
+
fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling AccountsApi.get_accounts_by_created" if lower_threshold.nil?
|
438
|
+
# verify the required parameter 'upper_threshold' is set
|
439
|
+
fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling AccountsApi.get_accounts_by_created" if upper_threshold.nil?
|
440
|
+
if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
|
441
|
+
fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
|
442
|
+
end
|
443
|
+
# resource path
|
444
|
+
local_var_path = "/accounts/created/{lower-threshold}/{upper-threshold}".sub('{format}','json').sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)
|
445
|
+
|
446
|
+
# query parameters
|
447
|
+
query_params = {}
|
448
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
449
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
450
|
+
query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
|
451
|
+
query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
452
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
453
|
+
query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
|
454
|
+
|
455
|
+
# header parameters
|
456
|
+
header_params = {}
|
457
|
+
|
458
|
+
# HTTP header 'Accept' (if needed)
|
459
|
+
local_header_accept = ['text/plain', 'application/json']
|
460
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
461
|
+
|
462
|
+
# HTTP header 'Content-Type'
|
463
|
+
local_header_content_type = []
|
464
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
465
|
+
|
466
|
+
# form parameters
|
467
|
+
form_params = {}
|
468
|
+
|
469
|
+
# http body (model)
|
470
|
+
post_body = nil
|
471
|
+
auth_names = []
|
472
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
473
|
+
:header_params => header_params,
|
474
|
+
:query_params => query_params,
|
475
|
+
:form_params => form_params,
|
476
|
+
:body => post_body,
|
477
|
+
:auth_names => auth_names,
|
478
|
+
:return_type => 'AccountPagedMetadata')
|
479
|
+
if @api_client.config.debugging
|
480
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_accounts_by_created\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
481
|
+
end
|
482
|
+
return data, status_code, headers
|
483
|
+
end
|
484
|
+
|
485
|
+
# Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
486
|
+
# {\"nickname\":\"Retrieve by updated\",\"response\":\"getAccountByUpdated.html\"}
|
487
|
+
# @param lower_threshold The UTC DateTime specifying the start of the result period.
|
488
|
+
# @param upper_threshold The UTC DateTime specifying the end of the result period.
|
489
|
+
# @param [Hash] opts the optional parameters
|
490
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
491
|
+
# @option opts [Integer] :offset The offset from the first taxation-link to return. (default to 0)
|
492
|
+
# @option opts [Integer] :records The maximum number of taxation-links to return. (default to 10)
|
493
|
+
# @option opts [String] :order_by Specify a field used to order the result set. (default to created)
|
494
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
|
495
|
+
# @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to true)
|
496
|
+
# @return [AccountPagedMetadata]
|
497
|
+
def get_accounts_by_updated(lower_threshold, upper_threshold, opts = {})
|
498
|
+
data, _status_code, _headers = get_accounts_by_updated_with_http_info(lower_threshold, upper_threshold, opts)
|
499
|
+
return data
|
500
|
+
end
|
501
|
+
|
502
|
+
# Returns a collection of account objects with updated times within the period specified by the lower-threshold and upper-threshold parameters. By default 10 values are returned. Records are returned in natural order.
|
503
|
+
# {\"nickname\":\"Retrieve by updated\",\"response\":\"getAccountByUpdated.html\"}
|
504
|
+
# @param lower_threshold The UTC DateTime specifying the start of the result period.
|
505
|
+
# @param upper_threshold The UTC DateTime specifying the end of the result period.
|
506
|
+
# @param [Hash] opts the optional parameters
|
507
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
508
|
+
# @option opts [Integer] :offset The offset from the first taxation-link to return.
|
509
|
+
# @option opts [Integer] :records The maximum number of taxation-links to return.
|
510
|
+
# @option opts [String] :order_by Specify a field used to order the result set.
|
511
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
|
512
|
+
# @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
|
513
|
+
# @return [Array<(AccountPagedMetadata, Fixnum, Hash)>] AccountPagedMetadata data, response status code and response headers
|
514
|
+
def get_accounts_by_updated_with_http_info(lower_threshold, upper_threshold, opts = {})
|
515
|
+
if @api_client.config.debugging
|
516
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_accounts_by_updated ..."
|
517
|
+
end
|
518
|
+
# verify the required parameter 'lower_threshold' is set
|
519
|
+
fail ArgumentError, "Missing the required parameter 'lower_threshold' when calling AccountsApi.get_accounts_by_updated" if lower_threshold.nil?
|
520
|
+
# verify the required parameter 'upper_threshold' is set
|
521
|
+
fail ArgumentError, "Missing the required parameter 'upper_threshold' when calling AccountsApi.get_accounts_by_updated" if upper_threshold.nil?
|
522
|
+
if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
|
523
|
+
fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
|
524
|
+
end
|
525
|
+
# resource path
|
526
|
+
local_var_path = "/accounts/updated/{lower-threshold}/{upper-threshold}".sub('{format}','json').sub('{' + 'lower-threshold' + '}', lower_threshold.to_s).sub('{' + 'upper-threshold' + '}', upper_threshold.to_s)
|
527
|
+
|
528
|
+
# query parameters
|
529
|
+
query_params = {}
|
530
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
531
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
532
|
+
query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
|
533
|
+
query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
534
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
535
|
+
query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
|
536
|
+
|
537
|
+
# header parameters
|
538
|
+
header_params = {}
|
539
|
+
|
540
|
+
# HTTP header 'Accept' (if needed)
|
541
|
+
local_header_accept = ['text/plain', 'application/json']
|
542
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
543
|
+
|
544
|
+
# HTTP header 'Content-Type'
|
545
|
+
local_header_content_type = []
|
546
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
547
|
+
|
548
|
+
# form parameters
|
549
|
+
form_params = {}
|
550
|
+
|
551
|
+
# http body (model)
|
552
|
+
post_body = nil
|
553
|
+
auth_names = []
|
554
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
555
|
+
:header_params => header_params,
|
556
|
+
:query_params => query_params,
|
557
|
+
:form_params => form_params,
|
558
|
+
:body => post_body,
|
559
|
+
:auth_names => auth_names,
|
560
|
+
:return_type => 'AccountPagedMetadata')
|
561
|
+
if @api_client.config.debugging
|
562
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_accounts_by_updated\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
563
|
+
end
|
564
|
+
return data, status_code, headers
|
565
|
+
end
|
566
|
+
|
567
|
+
# Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
568
|
+
# {\"nickname\":\"Retrieve by user\",\"response\":\"getAccountByUserID.html\"}
|
569
|
+
# @param user_id
|
570
|
+
# @param [Hash] opts the optional parameters
|
571
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
572
|
+
# @option opts [Integer] :offset The offset from the first account to return. (default to 0)
|
573
|
+
# @option opts [Integer] :records The maximum number of accounts to return. (default to 10)
|
574
|
+
# @option opts [String] :order_by Specify a field used to order the result set. (default to created)
|
575
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
|
576
|
+
# @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to true)
|
577
|
+
# @return [AccountPagedMetadata]
|
578
|
+
def get_accounts_by_user_id(user_id, opts = {})
|
579
|
+
data, _status_code, _headers = get_accounts_by_user_id_with_http_info(user_id, opts)
|
580
|
+
return data
|
581
|
+
end
|
582
|
+
|
583
|
+
# Returns a collection of accounts, specified by the user-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
584
|
+
# {\"nickname\":\"Retrieve by user\",\"response\":\"getAccountByUserID.html\"}
|
585
|
+
# @param user_id
|
586
|
+
# @param [Hash] opts the optional parameters
|
587
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
588
|
+
# @option opts [Integer] :offset The offset from the first account to return.
|
589
|
+
# @option opts [Integer] :records The maximum number of accounts to return.
|
590
|
+
# @option opts [String] :order_by Specify a field used to order the result set.
|
591
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
|
592
|
+
# @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
|
593
|
+
# @return [Array<(AccountPagedMetadata, Fixnum, Hash)>] AccountPagedMetadata data, response status code and response headers
|
594
|
+
def get_accounts_by_user_id_with_http_info(user_id, opts = {})
|
595
|
+
if @api_client.config.debugging
|
596
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_accounts_by_user_id ..."
|
597
|
+
end
|
598
|
+
# verify the required parameter 'user_id' is set
|
599
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AccountsApi.get_accounts_by_user_id" if user_id.nil?
|
600
|
+
if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
|
601
|
+
fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
|
602
|
+
end
|
603
|
+
# resource path
|
604
|
+
local_var_path = "/accounts/user/{user-ID}".sub('{format}','json').sub('{' + 'user-ID' + '}', user_id.to_s)
|
605
|
+
|
606
|
+
# query parameters
|
607
|
+
query_params = {}
|
608
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
609
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
610
|
+
query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
|
611
|
+
query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
612
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
613
|
+
query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
|
614
|
+
|
615
|
+
# header parameters
|
616
|
+
header_params = {}
|
617
|
+
|
618
|
+
# HTTP header 'Accept' (if needed)
|
619
|
+
local_header_accept = ['application/json']
|
620
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
621
|
+
|
622
|
+
# HTTP header 'Content-Type'
|
623
|
+
local_header_content_type = ['text/plain', 'application/json']
|
624
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
625
|
+
|
626
|
+
# form parameters
|
627
|
+
form_params = {}
|
628
|
+
|
629
|
+
# http body (model)
|
630
|
+
post_body = nil
|
631
|
+
auth_names = []
|
632
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
633
|
+
:header_params => header_params,
|
634
|
+
:query_params => query_params,
|
635
|
+
:form_params => form_params,
|
636
|
+
:body => post_body,
|
637
|
+
:auth_names => auth_names,
|
638
|
+
:return_type => 'AccountPagedMetadata')
|
639
|
+
if @api_client.config.debugging
|
640
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_accounts_by_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
641
|
+
end
|
642
|
+
return data, status_code, headers
|
643
|
+
end
|
644
|
+
|
645
|
+
# Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order.
|
646
|
+
# {\"nickname\":\"Get all accounts\",\"response\":\"getAccountAll.html\"}
|
647
|
+
# @param [Hash] opts the optional parameters
|
648
|
+
# @option opts [Array<String>] :id A list of account IDs used to filter the output.
|
649
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
650
|
+
# @option opts [Integer] :offset The offset from the first taxation-link to return. (default to 0)
|
651
|
+
# @option opts [Integer] :records The maximum number of taxation-links to return. (default to 10)
|
652
|
+
# @option opts [String] :order_by Specify a field used to order the result set. (default to created)
|
653
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
|
654
|
+
# @option opts [BOOLEAN] :include_retired Whether retired products should be returned. (default to true)
|
655
|
+
# @option opts [BOOLEAN] :users_only Whether only accounts have a user should be returned. (default to false)
|
656
|
+
# @option opts [String] :metadata
|
657
|
+
# @return [AccountPagedMetadata]
|
658
|
+
def get_all_accounts(opts = {})
|
659
|
+
data, _status_code, _headers = get_all_accounts_with_http_info(opts)
|
660
|
+
return data
|
661
|
+
end
|
662
|
+
|
663
|
+
# Returns a collection of all account objects. By default 10 values are returned. Records are returned in natural order.
|
664
|
+
# {\"nickname\":\"Get all accounts\",\"response\":\"getAccountAll.html\"}
|
665
|
+
# @param [Hash] opts the optional parameters
|
666
|
+
# @option opts [Array<String>] :id A list of account IDs used to filter the output.
|
667
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
668
|
+
# @option opts [Integer] :offset The offset from the first taxation-link to return.
|
669
|
+
# @option opts [Integer] :records The maximum number of taxation-links to return.
|
670
|
+
# @option opts [String] :order_by Specify a field used to order the result set.
|
671
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
|
672
|
+
# @option opts [BOOLEAN] :include_retired Whether retired products should be returned.
|
673
|
+
# @option opts [BOOLEAN] :users_only Whether only accounts have a user should be returned.
|
674
|
+
# @option opts [String] :metadata
|
675
|
+
# @return [Array<(AccountPagedMetadata, Fixnum, Hash)>] AccountPagedMetadata data, response status code and response headers
|
676
|
+
def get_all_accounts_with_http_info(opts = {})
|
677
|
+
if @api_client.config.debugging
|
678
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_all_accounts ..."
|
679
|
+
end
|
680
|
+
if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
|
681
|
+
fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
|
682
|
+
end
|
683
|
+
# resource path
|
684
|
+
local_var_path = "/accounts".sub('{format}','json')
|
685
|
+
|
686
|
+
# query parameters
|
687
|
+
query_params = {}
|
688
|
+
query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if !opts[:'id'].nil?
|
689
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
690
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
691
|
+
query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
|
692
|
+
query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
693
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
694
|
+
query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
|
695
|
+
query_params[:'users_only'] = opts[:'users_only'] if !opts[:'users_only'].nil?
|
696
|
+
query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?
|
697
|
+
|
698
|
+
# header parameters
|
699
|
+
header_params = {}
|
700
|
+
|
701
|
+
# HTTP header 'Accept' (if needed)
|
702
|
+
local_header_accept = ['text/plain', 'application/json']
|
703
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
704
|
+
|
705
|
+
# HTTP header 'Content-Type'
|
706
|
+
local_header_content_type = []
|
707
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
708
|
+
|
709
|
+
# form parameters
|
710
|
+
form_params = {}
|
711
|
+
|
712
|
+
# http body (model)
|
713
|
+
post_body = nil
|
714
|
+
auth_names = []
|
715
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
716
|
+
:header_params => header_params,
|
717
|
+
:query_params => query_params,
|
718
|
+
:form_params => form_params,
|
719
|
+
:body => post_body,
|
720
|
+
:auth_names => auth_names,
|
721
|
+
:return_type => 'AccountPagedMetadata')
|
722
|
+
if @api_client.config.debugging
|
723
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_all_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
724
|
+
end
|
725
|
+
return data, status_code, headers
|
726
|
+
end
|
727
|
+
|
728
|
+
# Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order.
|
729
|
+
# {\"nickname\":\"Get available credit\",\"response\":\"getAvailableCreditAccount.html\"}
|
730
|
+
# @param account_id The ID of the account
|
731
|
+
# @param [Hash] opts the optional parameters
|
732
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
733
|
+
# @option opts [Integer] :offset The offset from the first subscription to return. (default to 0)
|
734
|
+
# @option opts [Integer] :records The maximum number of subscriptions to return. (default to 10)
|
735
|
+
# @option opts [String] :order_by Specify a field used to order the result set. (default to id)
|
736
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
|
737
|
+
# @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned. (default to false)
|
738
|
+
# @return [CreditNotePagedMetadata]
|
739
|
+
def get_available_credit_on_account(account_id, opts = {})
|
740
|
+
data, _status_code, _headers = get_available_credit_on_account_with_http_info(account_id, opts)
|
741
|
+
return data
|
742
|
+
end
|
743
|
+
|
744
|
+
# Returns all available credit-notes for the specified account. By default 10 values are returned. Records are returned in natural order.
|
745
|
+
# {\"nickname\":\"Get available credit\",\"response\":\"getAvailableCreditAccount.html\"}
|
746
|
+
# @param account_id The ID of the account
|
747
|
+
# @param [Hash] opts the optional parameters
|
748
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
749
|
+
# @option opts [Integer] :offset The offset from the first subscription to return.
|
750
|
+
# @option opts [Integer] :records The maximum number of subscriptions to return.
|
751
|
+
# @option opts [String] :order_by Specify a field used to order the result set.
|
752
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
|
753
|
+
# @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned.
|
754
|
+
# @return [Array<(CreditNotePagedMetadata, Fixnum, Hash)>] CreditNotePagedMetadata data, response status code and response headers
|
755
|
+
def get_available_credit_on_account_with_http_info(account_id, opts = {})
|
756
|
+
if @api_client.config.debugging
|
757
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_available_credit_on_account ..."
|
758
|
+
end
|
759
|
+
# verify the required parameter 'account_id' is set
|
760
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_available_credit_on_account" if account_id.nil?
|
761
|
+
if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
|
762
|
+
fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
|
763
|
+
end
|
764
|
+
# resource path
|
765
|
+
local_var_path = "/accounts/{account-ID}/credit".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s)
|
766
|
+
|
767
|
+
# query parameters
|
768
|
+
query_params = {}
|
769
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
770
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
771
|
+
query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
|
772
|
+
query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
773
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
774
|
+
query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
|
775
|
+
|
776
|
+
# header parameters
|
777
|
+
header_params = {}
|
778
|
+
|
779
|
+
# HTTP header 'Accept' (if needed)
|
780
|
+
local_header_accept = ['application/json']
|
781
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
782
|
+
|
783
|
+
# HTTP header 'Content-Type'
|
784
|
+
local_header_content_type = ['text/plain', 'application/json']
|
785
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
786
|
+
|
787
|
+
# form parameters
|
788
|
+
form_params = {}
|
789
|
+
|
790
|
+
# http body (model)
|
791
|
+
post_body = nil
|
792
|
+
auth_names = []
|
793
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
794
|
+
:header_params => header_params,
|
795
|
+
:query_params => query_params,
|
796
|
+
:form_params => form_params,
|
797
|
+
:body => post_body,
|
798
|
+
:auth_names => auth_names,
|
799
|
+
:return_type => 'CreditNotePagedMetadata')
|
800
|
+
if @api_client.config.debugging
|
801
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_available_credit_on_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
802
|
+
end
|
803
|
+
return data, status_code, headers
|
804
|
+
end
|
805
|
+
|
806
|
+
# Retrieve any associated metadata.
|
807
|
+
# {\"nickname\":\"Retrieve metadata on account\",\"request\":\"getAccountMetadataRequest.html\",\"response\":\"getAccountMetadataResponse.html\"}
|
808
|
+
# @param account_id
|
809
|
+
# @param [Hash] opts the optional parameters
|
810
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
811
|
+
# @return [DynamicMetadata]
|
812
|
+
def get_metadata_for_account(account_id, opts = {})
|
813
|
+
data, _status_code, _headers = get_metadata_for_account_with_http_info(account_id, opts)
|
814
|
+
return data
|
815
|
+
end
|
816
|
+
|
817
|
+
# Retrieve any associated metadata.
|
818
|
+
# {\"nickname\":\"Retrieve metadata on account\",\"request\":\"getAccountMetadataRequest.html\",\"response\":\"getAccountMetadataResponse.html\"}
|
819
|
+
# @param account_id
|
820
|
+
# @param [Hash] opts the optional parameters
|
821
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
822
|
+
# @return [Array<(DynamicMetadata, Fixnum, Hash)>] DynamicMetadata data, response status code and response headers
|
823
|
+
def get_metadata_for_account_with_http_info(account_id, opts = {})
|
824
|
+
if @api_client.config.debugging
|
825
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_metadata_for_account ..."
|
826
|
+
end
|
827
|
+
# verify the required parameter 'account_id' is set
|
828
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_metadata_for_account" if account_id.nil?
|
829
|
+
# resource path
|
830
|
+
local_var_path = "/accounts/{account-ID}/metadata".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s)
|
831
|
+
|
832
|
+
# query parameters
|
833
|
+
query_params = {}
|
834
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
835
|
+
|
836
|
+
# header parameters
|
837
|
+
header_params = {}
|
838
|
+
|
839
|
+
# HTTP header 'Accept' (if needed)
|
840
|
+
local_header_accept = ['application/json']
|
841
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
842
|
+
|
843
|
+
# HTTP header 'Content-Type'
|
844
|
+
local_header_content_type = ['text/plain', 'application/json']
|
845
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
846
|
+
|
847
|
+
# form parameters
|
848
|
+
form_params = {}
|
849
|
+
|
850
|
+
# http body (model)
|
851
|
+
post_body = nil
|
852
|
+
auth_names = []
|
853
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
854
|
+
:header_params => header_params,
|
855
|
+
:query_params => query_params,
|
856
|
+
:form_params => form_params,
|
857
|
+
:body => post_body,
|
858
|
+
:auth_names => auth_names,
|
859
|
+
:return_type => 'DynamicMetadata')
|
860
|
+
if @api_client.config.debugging
|
861
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_metadata_for_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
862
|
+
end
|
863
|
+
return data, status_code, headers
|
864
|
+
end
|
865
|
+
|
866
|
+
# Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
867
|
+
# {\"nickname\":\"List roles on account\",\"response\":\"getRoleByAccount.html\"}
|
868
|
+
# @param account_id
|
869
|
+
# @param [Hash] opts the optional parameters
|
870
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
871
|
+
# @option opts [Integer] :offset The offset from the first subscription to return. (default to 0)
|
872
|
+
# @option opts [Integer] :records The maximum number of subscriptions to return. (default to 10)
|
873
|
+
# @option opts [String] :order_by Specify a field used to order the result set. (default to id)
|
874
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC)
|
875
|
+
# @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned. (default to false)
|
876
|
+
# @return [RolePagedMetadata]
|
877
|
+
def get_permissions_on_account(account_id, opts = {})
|
878
|
+
data, _status_code, _headers = get_permissions_on_account_with_http_info(account_id, opts)
|
879
|
+
return data
|
880
|
+
end
|
881
|
+
|
882
|
+
# Retrieves a collection of roles, specified by the account-ID parameter. By default 10 values are returned. Records are returned in natural order.
|
883
|
+
# {\"nickname\":\"List roles on account\",\"response\":\"getRoleByAccount.html\"}
|
884
|
+
# @param account_id
|
885
|
+
# @param [Hash] opts the optional parameters
|
886
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
887
|
+
# @option opts [Integer] :offset The offset from the first subscription to return.
|
888
|
+
# @option opts [Integer] :records The maximum number of subscriptions to return.
|
889
|
+
# @option opts [String] :order_by Specify a field used to order the result set.
|
890
|
+
# @option opts [String] :order Ihe direction of any ordering, either ASC or DESC.
|
891
|
+
# @option opts [BOOLEAN] :include_retired Whether retired subscriptions should be returned.
|
892
|
+
# @return [Array<(RolePagedMetadata, Fixnum, Hash)>] RolePagedMetadata data, response status code and response headers
|
893
|
+
def get_permissions_on_account_with_http_info(account_id, opts = {})
|
894
|
+
if @api_client.config.debugging
|
895
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.get_permissions_on_account ..."
|
896
|
+
end
|
897
|
+
# verify the required parameter 'account_id' is set
|
898
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_permissions_on_account" if account_id.nil?
|
899
|
+
if opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
|
900
|
+
fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
|
901
|
+
end
|
902
|
+
# resource path
|
903
|
+
local_var_path = "/accounts/{account-ID}/roles".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s)
|
904
|
+
|
905
|
+
# query parameters
|
906
|
+
query_params = {}
|
907
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
908
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
909
|
+
query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
|
910
|
+
query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
911
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
912
|
+
query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?
|
913
|
+
|
914
|
+
# header parameters
|
915
|
+
header_params = {}
|
916
|
+
|
917
|
+
# HTTP header 'Accept' (if needed)
|
918
|
+
local_header_accept = ['application/json']
|
919
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
920
|
+
|
921
|
+
# HTTP header 'Content-Type'
|
922
|
+
local_header_content_type = ['text/plain']
|
923
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
924
|
+
|
925
|
+
# form parameters
|
926
|
+
form_params = {}
|
927
|
+
|
928
|
+
# http body (model)
|
929
|
+
post_body = nil
|
930
|
+
auth_names = []
|
931
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
932
|
+
:header_params => header_params,
|
933
|
+
:query_params => query_params,
|
934
|
+
:form_params => form_params,
|
935
|
+
:body => post_body,
|
936
|
+
:auth_names => auth_names,
|
937
|
+
:return_type => 'RolePagedMetadata')
|
938
|
+
if @api_client.config.debugging
|
939
|
+
@api_client.config.logger.debug "API called: AccountsApi#get_permissions_on_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
940
|
+
end
|
941
|
+
return data, status_code, headers
|
942
|
+
end
|
943
|
+
|
944
|
+
# Decrease the amount of credit by the value specified or entirely if no value provided.
|
945
|
+
# {\"nickname\":\"Remove Credit\",\"response\":\"removeCreditForAccount.html\"}
|
946
|
+
# @param account_id
|
947
|
+
# @param value <p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed from this credit note.</p><p>If a currency value is provided the format should be in the form of valueCurrency, where value is the value to remove. The currency should be an ISO 4217 Currency Code. For example setting the value as 10USD will reduce the credit on this account by $10 or 9.86USD would reduce the credit by $9.86. Note: the value will be reduced from any credit notes with available balance.</p>
|
948
|
+
# @param [Hash] opts the optional parameters
|
949
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
950
|
+
# @return [CreditNotePagedMetadata]
|
951
|
+
def remove_credit_from_account(account_id, value, opts = {})
|
952
|
+
data, _status_code, _headers = remove_credit_from_account_with_http_info(account_id, value, opts)
|
953
|
+
return data
|
954
|
+
end
|
955
|
+
|
956
|
+
# Decrease the amount of credit by the value specified or entirely if no value provided.
|
957
|
+
# {\"nickname\":\"Remove Credit\",\"response\":\"removeCreditForAccount.html\"}
|
958
|
+
# @param account_id
|
959
|
+
# @param value <p>Either a credit note ID or a currency value.</p><p>If a credit note ID is provided any remaining credit will be removed from this credit note.</p><p>If a currency value is provided the format should be in the form of valueCurrency, where value is the value to remove. The currency should be an ISO 4217 Currency Code. For example setting the value as 10USD will reduce the credit on this account by $10 or 9.86USD would reduce the credit by $9.86. Note: the value will be reduced from any credit notes with available balance.</p>
|
960
|
+
# @param [Hash] opts the optional parameters
|
961
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
962
|
+
# @return [Array<(CreditNotePagedMetadata, Fixnum, Hash)>] CreditNotePagedMetadata data, response status code and response headers
|
963
|
+
def remove_credit_from_account_with_http_info(account_id, value, opts = {})
|
964
|
+
if @api_client.config.debugging
|
965
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.remove_credit_from_account ..."
|
966
|
+
end
|
967
|
+
# verify the required parameter 'account_id' is set
|
968
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.remove_credit_from_account" if account_id.nil?
|
969
|
+
# verify the required parameter 'value' is set
|
970
|
+
fail ArgumentError, "Missing the required parameter 'value' when calling AccountsApi.remove_credit_from_account" if value.nil?
|
971
|
+
# resource path
|
972
|
+
local_var_path = "/accounts/{account-ID}/credit/{value}".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s).sub('{' + 'value' + '}', value.to_s)
|
973
|
+
|
974
|
+
# query parameters
|
975
|
+
query_params = {}
|
976
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
977
|
+
|
978
|
+
# header parameters
|
979
|
+
header_params = {}
|
980
|
+
|
981
|
+
# HTTP header 'Accept' (if needed)
|
982
|
+
local_header_accept = ['application/json']
|
983
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
984
|
+
|
985
|
+
# HTTP header 'Content-Type'
|
986
|
+
local_header_content_type = ['text/plain', 'application/json']
|
987
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
988
|
+
|
989
|
+
# form parameters
|
990
|
+
form_params = {}
|
991
|
+
|
992
|
+
# http body (model)
|
993
|
+
post_body = nil
|
994
|
+
auth_names = []
|
995
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
996
|
+
:header_params => header_params,
|
997
|
+
:query_params => query_params,
|
998
|
+
:form_params => form_params,
|
999
|
+
:body => post_body,
|
1000
|
+
:auth_names => auth_names,
|
1001
|
+
:return_type => 'CreditNotePagedMetadata')
|
1002
|
+
if @api_client.config.debugging
|
1003
|
+
@api_client.config.logger.debug "API called: AccountsApi#remove_credit_from_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1004
|
+
end
|
1005
|
+
return data, status_code, headers
|
1006
|
+
end
|
1007
|
+
|
1008
|
+
# Revoke the specified role.
|
1009
|
+
# {\"nickname\":\"Remove Role\",\"response\":\"removeRoleFromAccount.html\"}
|
1010
|
+
# @param account_id
|
1011
|
+
# @param role ID or name of the role.
|
1012
|
+
# @param [Hash] opts the optional parameters
|
1013
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
1014
|
+
# @return [RolePagedMetadata]
|
1015
|
+
def remove_permission_from_account(account_id, role, opts = {})
|
1016
|
+
data, _status_code, _headers = remove_permission_from_account_with_http_info(account_id, role, opts)
|
1017
|
+
return data
|
1018
|
+
end
|
1019
|
+
|
1020
|
+
# Revoke the specified role.
|
1021
|
+
# {\"nickname\":\"Remove Role\",\"response\":\"removeRoleFromAccount.html\"}
|
1022
|
+
# @param account_id
|
1023
|
+
# @param role ID or name of the role.
|
1024
|
+
# @param [Hash] opts the optional parameters
|
1025
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
1026
|
+
# @return [Array<(RolePagedMetadata, Fixnum, Hash)>] RolePagedMetadata data, response status code and response headers
|
1027
|
+
def remove_permission_from_account_with_http_info(account_id, role, opts = {})
|
1028
|
+
if @api_client.config.debugging
|
1029
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.remove_permission_from_account ..."
|
1030
|
+
end
|
1031
|
+
# verify the required parameter 'account_id' is set
|
1032
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.remove_permission_from_account" if account_id.nil?
|
1033
|
+
# verify the required parameter 'role' is set
|
1034
|
+
fail ArgumentError, "Missing the required parameter 'role' when calling AccountsApi.remove_permission_from_account" if role.nil?
|
1035
|
+
# resource path
|
1036
|
+
local_var_path = "/accounts/{account-ID}/roles/{role}".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s).sub('{' + 'role' + '}', role.to_s)
|
1037
|
+
|
1038
|
+
# query parameters
|
1039
|
+
query_params = {}
|
1040
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
1041
|
+
|
1042
|
+
# header parameters
|
1043
|
+
header_params = {}
|
1044
|
+
|
1045
|
+
# HTTP header 'Accept' (if needed)
|
1046
|
+
local_header_accept = ['application/json']
|
1047
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1048
|
+
|
1049
|
+
# HTTP header 'Content-Type'
|
1050
|
+
local_header_content_type = ['text/plain']
|
1051
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1052
|
+
|
1053
|
+
# form parameters
|
1054
|
+
form_params = {}
|
1055
|
+
|
1056
|
+
# http body (model)
|
1057
|
+
post_body = nil
|
1058
|
+
auth_names = []
|
1059
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
1060
|
+
:header_params => header_params,
|
1061
|
+
:query_params => query_params,
|
1062
|
+
:form_params => form_params,
|
1063
|
+
:body => post_body,
|
1064
|
+
:auth_names => auth_names,
|
1065
|
+
:return_type => 'RolePagedMetadata')
|
1066
|
+
if @api_client.config.debugging
|
1067
|
+
@api_client.config.logger.debug "API called: AccountsApi#remove_permission_from_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1068
|
+
end
|
1069
|
+
return data, status_code, headers
|
1070
|
+
end
|
1071
|
+
|
1072
|
+
# Remove any existing metadata keys and create the provided data.
|
1073
|
+
# {\"nickname\":\"Set metadata on account\",\"request\":\"setAccountMetadataRequest.html\",\"response\":\"setAccountMetadataResponse.html\"}
|
1074
|
+
# @param metadata
|
1075
|
+
# @param account_id
|
1076
|
+
# @param [Hash] opts the optional parameters
|
1077
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
1078
|
+
# @return [DynamicMetadata]
|
1079
|
+
def set_metadata_for_account(metadata, account_id, opts = {})
|
1080
|
+
data, _status_code, _headers = set_metadata_for_account_with_http_info(metadata, account_id, opts)
|
1081
|
+
return data
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
# Remove any existing metadata keys and create the provided data.
|
1085
|
+
# {\"nickname\":\"Set metadata on account\",\"request\":\"setAccountMetadataRequest.html\",\"response\":\"setAccountMetadataResponse.html\"}
|
1086
|
+
# @param metadata
|
1087
|
+
# @param account_id
|
1088
|
+
# @param [Hash] opts the optional parameters
|
1089
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
1090
|
+
# @return [Array<(DynamicMetadata, Fixnum, Hash)>] DynamicMetadata data, response status code and response headers
|
1091
|
+
def set_metadata_for_account_with_http_info(metadata, account_id, opts = {})
|
1092
|
+
if @api_client.config.debugging
|
1093
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.set_metadata_for_account ..."
|
1094
|
+
end
|
1095
|
+
# verify the required parameter 'metadata' is set
|
1096
|
+
fail ArgumentError, "Missing the required parameter 'metadata' when calling AccountsApi.set_metadata_for_account" if metadata.nil?
|
1097
|
+
# verify the required parameter 'account_id' is set
|
1098
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.set_metadata_for_account" if account_id.nil?
|
1099
|
+
# resource path
|
1100
|
+
local_var_path = "/accounts/{account-ID}/metadata".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s)
|
1101
|
+
|
1102
|
+
# query parameters
|
1103
|
+
query_params = {}
|
1104
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
1105
|
+
|
1106
|
+
# header parameters
|
1107
|
+
header_params = {}
|
1108
|
+
|
1109
|
+
# HTTP header 'Accept' (if needed)
|
1110
|
+
local_header_accept = ['application/json']
|
1111
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1112
|
+
|
1113
|
+
# HTTP header 'Content-Type'
|
1114
|
+
local_header_content_type = ['application/json']
|
1115
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1116
|
+
|
1117
|
+
# form parameters
|
1118
|
+
form_params = {}
|
1119
|
+
|
1120
|
+
# http body (model)
|
1121
|
+
post_body = @api_client.object_to_http_body(metadata)
|
1122
|
+
auth_names = []
|
1123
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1124
|
+
:header_params => header_params,
|
1125
|
+
:query_params => query_params,
|
1126
|
+
:form_params => form_params,
|
1127
|
+
:body => post_body,
|
1128
|
+
:auth_names => auth_names,
|
1129
|
+
:return_type => 'DynamicMetadata')
|
1130
|
+
if @api_client.config.debugging
|
1131
|
+
@api_client.config.logger.debug "API called: AccountsApi#set_metadata_for_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1132
|
+
end
|
1133
|
+
return data, status_code, headers
|
1134
|
+
end
|
1135
|
+
|
1136
|
+
# Update an Account.
|
1137
|
+
# {\"nickname\":\"Update an account\",\"response\":\"updateAccountResponse.html\",\"request\":\"updateAccountRequest.html\"}
|
1138
|
+
# @param account The account object to be created.
|
1139
|
+
# @param [Hash] opts the optional parameters
|
1140
|
+
# @return [AccountPagedMetadata]
|
1141
|
+
def update_account(account, opts = {})
|
1142
|
+
data, _status_code, _headers = update_account_with_http_info(account, opts)
|
1143
|
+
return data
|
1144
|
+
end
|
1145
|
+
|
1146
|
+
# Update an Account.
|
1147
|
+
# {\"nickname\":\"Update an account\",\"response\":\"updateAccountResponse.html\",\"request\":\"updateAccountRequest.html\"}
|
1148
|
+
# @param account The account object to be created.
|
1149
|
+
# @param [Hash] opts the optional parameters
|
1150
|
+
# @return [Array<(AccountPagedMetadata, Fixnum, Hash)>] AccountPagedMetadata data, response status code and response headers
|
1151
|
+
def update_account_with_http_info(account, opts = {})
|
1152
|
+
if @api_client.config.debugging
|
1153
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.update_account ..."
|
1154
|
+
end
|
1155
|
+
# verify the required parameter 'account' is set
|
1156
|
+
fail ArgumentError, "Missing the required parameter 'account' when calling AccountsApi.update_account" if account.nil?
|
1157
|
+
# resource path
|
1158
|
+
local_var_path = "/accounts".sub('{format}','json')
|
1159
|
+
|
1160
|
+
# query parameters
|
1161
|
+
query_params = {}
|
1162
|
+
|
1163
|
+
# header parameters
|
1164
|
+
header_params = {}
|
1165
|
+
|
1166
|
+
# HTTP header 'Accept' (if needed)
|
1167
|
+
local_header_accept = ['text/xml', 'application/xml', 'application/json']
|
1168
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1169
|
+
|
1170
|
+
# HTTP header 'Content-Type'
|
1171
|
+
local_header_content_type = ['application/json']
|
1172
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1173
|
+
|
1174
|
+
# form parameters
|
1175
|
+
form_params = {}
|
1176
|
+
|
1177
|
+
# http body (model)
|
1178
|
+
post_body = @api_client.object_to_http_body(account)
|
1179
|
+
auth_names = []
|
1180
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1181
|
+
:header_params => header_params,
|
1182
|
+
:query_params => query_params,
|
1183
|
+
:form_params => form_params,
|
1184
|
+
:body => post_body,
|
1185
|
+
:auth_names => auth_names,
|
1186
|
+
:return_type => 'AccountPagedMetadata')
|
1187
|
+
if @api_client.config.debugging
|
1188
|
+
@api_client.config.logger.debug "API called: AccountsApi#update_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1189
|
+
end
|
1190
|
+
return data, status_code, headers
|
1191
|
+
end
|
1192
|
+
|
1193
|
+
# Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
1194
|
+
# {\"nickname\":\"Upsert metadata on account\",\"request\":\"upsertAccountMetadataRequest.html\",\"response\":\"upsertAccountMetadataResponse.html\"}
|
1195
|
+
# @param metadata
|
1196
|
+
# @param account_id
|
1197
|
+
# @param [Hash] opts the optional parameters
|
1198
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
1199
|
+
# @return [DynamicMetadata]
|
1200
|
+
def upsert_metadata_for_account(metadata, account_id, opts = {})
|
1201
|
+
data, _status_code, _headers = upsert_metadata_for_account_with_http_info(metadata, account_id, opts)
|
1202
|
+
return data
|
1203
|
+
end
|
1204
|
+
|
1205
|
+
# Update any existing metadata key-values and insert any new key-values, no keys will be removed.
|
1206
|
+
# {\"nickname\":\"Upsert metadata on account\",\"request\":\"upsertAccountMetadataRequest.html\",\"response\":\"upsertAccountMetadataResponse.html\"}
|
1207
|
+
# @param metadata
|
1208
|
+
# @param account_id
|
1209
|
+
# @param [Hash] opts the optional parameters
|
1210
|
+
# @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls.
|
1211
|
+
# @return [Array<(DynamicMetadata, Fixnum, Hash)>] DynamicMetadata data, response status code and response headers
|
1212
|
+
def upsert_metadata_for_account_with_http_info(metadata, account_id, opts = {})
|
1213
|
+
if @api_client.config.debugging
|
1214
|
+
@api_client.config.logger.debug "Calling API: AccountsApi.upsert_metadata_for_account ..."
|
1215
|
+
end
|
1216
|
+
# verify the required parameter 'metadata' is set
|
1217
|
+
fail ArgumentError, "Missing the required parameter 'metadata' when calling AccountsApi.upsert_metadata_for_account" if metadata.nil?
|
1218
|
+
# verify the required parameter 'account_id' is set
|
1219
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.upsert_metadata_for_account" if account_id.nil?
|
1220
|
+
# resource path
|
1221
|
+
local_var_path = "/accounts/{account-ID}/metadata".sub('{format}','json').sub('{' + 'account-ID' + '}', account_id.to_s)
|
1222
|
+
|
1223
|
+
# query parameters
|
1224
|
+
query_params = {}
|
1225
|
+
query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
|
1226
|
+
|
1227
|
+
# header parameters
|
1228
|
+
header_params = {}
|
1229
|
+
|
1230
|
+
# HTTP header 'Accept' (if needed)
|
1231
|
+
local_header_accept = ['application/json']
|
1232
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1233
|
+
|
1234
|
+
# HTTP header 'Content-Type'
|
1235
|
+
local_header_content_type = ['application/json']
|
1236
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1237
|
+
|
1238
|
+
# form parameters
|
1239
|
+
form_params = {}
|
1240
|
+
|
1241
|
+
# http body (model)
|
1242
|
+
post_body = @api_client.object_to_http_body(metadata)
|
1243
|
+
auth_names = []
|
1244
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1245
|
+
:header_params => header_params,
|
1246
|
+
:query_params => query_params,
|
1247
|
+
:form_params => form_params,
|
1248
|
+
:body => post_body,
|
1249
|
+
:auth_names => auth_names,
|
1250
|
+
:return_type => 'DynamicMetadata')
|
1251
|
+
if @api_client.config.debugging
|
1252
|
+
@api_client.config.logger.debug "API called: AccountsApi#upsert_metadata_for_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1253
|
+
end
|
1254
|
+
return data, status_code, headers
|
1255
|
+
end
|
1256
|
+
end
|
1257
|
+
end
|