Module: ChargeBee

Defined in:

lib/chargebee.rb,
lib/chargebee/rest.rb,
lib/chargebee/util.rb,
lib/chargebee/errors.rb,
lib/chargebee/result.rb,
lib/chargebee/request.rb,
lib/chargebee/environment.rb,
lib/chargebee/list_result.rb,
lib/chargebee/models/card.rb,
lib/chargebee/models/gift.rb,
lib/chargebee/models/item.rb,
lib/chargebee/models/plan.rb,
lib/chargebee/models/ramp.rb,
lib/chargebee/models/addon.rb,
lib/chargebee/models/event.rb,
lib/chargebee/models/model.rb,
lib/chargebee/models/order.rb,
lib/chargebee/models/quote.rb,
lib/chargebee/models/token.rb,
lib/chargebee/models/usage.rb,
lib/chargebee/models/coupon.rb,
lib/chargebee/models/export.rb,
lib/chargebee/models/address.rb,
lib/chargebee/models/comment.rb,
lib/chargebee/models/contact.rb,
lib/chargebee/models/feature.rb,
lib/chargebee/models/invoice.rb,
lib/chargebee/models/currency.rb,
lib/chargebee/models/customer.rb,
lib/chargebee/models/discount.rb,
lib/chargebee/models/download.rb,
lib/chargebee/models/estimate.rb,
lib/chargebee/models/metadata.rb,
lib/chargebee/models/purchase.rb,
lib/chargebee/models/attribute.rb,
lib/chargebee/models/hierarchy.rb,
lib/chargebee/models/coupon_set.rb,
lib/chargebee/models/item_price.rb,
lib/chargebee/models/coupon_code.rb,
lib/chargebee/models/credit_note.rb,
lib/chargebee/models/entitlement.rb,
lib/chargebee/models/hosted_page.rb,
lib/chargebee/models/item_family.rb,
lib/chargebee/models/transaction.rb,
lib/chargebee/models/csv_tax_rule.rb,
lib/chargebee/models/subscription.rb,
lib/chargebee/models/tax_withheld.rb,
lib/chargebee/models/time_machine.rb,
lib/chargebee/models/attached_item.rb,
lib/chargebee/models/configuration.rb,
lib/chargebee/models/contract_term.rb,
lib/chargebee/models/impacted_item.rb,
lib/chargebee/models/price_variant.rb,
lib/chargebee/models/quoted_charge.rb,
lib/chargebee/models/payment_intent.rb,
lib/chargebee/models/payment_source.rb,
lib/chargebee/models/portal_session.rb,
lib/chargebee/models/business_entity.rb,
lib/chargebee/models/payment_voucher.rb,
lib/chargebee/models/unbilled_charge.rb,
lib/chargebee/models/invoice_estimate.rb,
lib/chargebee/models/item_entitlement.rb,
lib/chargebee/models/non_subscription.rb,
lib/chargebee/models/payment_schedule.rb,
lib/chargebee/models/quote_line_group.rb,
lib/chargebee/models/recorded_purchase.rb,
lib/chargebee/models/differential_price.rb,
lib/chargebee/models/promotional_credit.rb,
lib/chargebee/models/resource_migration.rb,
lib/chargebee/models/impacted_item_price.rb,
lib/chargebee/models/in_app_subscription.rb,
lib/chargebee/models/quoted_subscription.rb,
lib/chargebee/models/credit_note_estimate.rb,
lib/chargebee/models/customer_entitlement.rb,
lib/chargebee/models/entitlement_override.rb,
lib/chargebee/models/gateway_error_detail.rb,
lib/chargebee/models/pricing_page_session.rb,
lib/chargebee/models/virtual_bank_account.rb,
lib/chargebee/models/impacted_subscription.rb,
lib/chargebee/models/site_migration_detail.rb,
lib/chargebee/models/subscription_estimate.rb,
lib/chargebee/models/omnichannel_transaction.rb,
lib/chargebee/models/payment_schedule_scheme.rb,
lib/chargebee/models/advance_invoice_schedule.rb,
lib/chargebee/models/business_entity_transfer.rb,
lib/chargebee/models/omnichannel_subscription.rb,
lib/chargebee/models/payment_reference_number.rb,
lib/chargebee/models/subscription_entitlement.rb,
lib/chargebee/models/payment_schedule_estimate.rb,
lib/chargebee/models/third_party_payment_method.rb,
lib/chargebee/models/omnichannel_subscription_item.rb

Defined Under Namespace

Modules: Rest, Util Classes: APIError, Addon, Address, AdvanceInvoiceSchedule, AttachedItem, Attribute, BusinessEntity, BusinessEntityTransfer, Card, Comment, Configuration, Contact, ContractTerm, Coupon, CouponCode, CouponSet, CreditNote, CreditNoteEstimate, CsvTaxRule, Currency, Customer, CustomerEntitlement, DifferentialPrice, Discount, Download, Entitlement, EntitlementOverride, Environment, Error, Estimate, Event, Export, Feature, GatewayErrorDetail, Gift, Hierarchy, HostedPage, IOError, ImpactedItem, ImpactedItemPrice, ImpactedSubscription, InAppSubscription, InvalidRequestError, Invoice, InvoiceEstimate, Item, ItemEntitlement, ItemFamily, ItemPrice, ListResult, Metadata, Model, NonSubscription, OmnichannelSubscription, OmnichannelSubscriptionItem, OmnichannelTransaction, OperationFailedError, Order, PaymentError, PaymentIntent, PaymentReferenceNumber, PaymentSchedule, PaymentScheduleEstimate, PaymentScheduleScheme, PaymentSource, PaymentVoucher, Plan, PortalSession, PriceVariant, PricingPageSession, PromotionalCredit, Purchase, Quote, QuoteLineGroup, QuotedCharge, QuotedSubscription, Ramp, RecordedPurchase, Request, ResourceMigration, Result, SiteMigrationDetail, Subscription, SubscriptionEntitlement, SubscriptionEstimate, TaxWithheld, ThirdPartyPaymentMethod, TimeMachine, Token, Transaction, UnbilledCharge, Usage, VirtualBankAccount

Constant Summary

VERSION =

'2.48.0'

@@default_env =

nil

@@verify_ca_certs =

true

@@ca_cert_path =

File.join(File.dirname(__FILE__), '/ssl/ca-certs.crt')

@@user_agent =

"Chargebee-Ruby-Client v#{self::VERSION}"

Class Method Summary

• .ca_cert_path ⇒ Object
• .configure(options) ⇒ Object
• .default_env ⇒ Object
• .source(source) ⇒ Object
• .update_connect_timeout_secs(connect_timeout) ⇒ Object
• .update_read_timeout_secs(read_timeout) ⇒ Object
• .user_agent ⇒ Object
• .verify_ca_certs=(verify) ⇒ Object
• .verify_ca_certs? ⇒ Boolean

Class Method Details

.ca_cert_path ⇒ Object

# File 'lib/chargebee.rb', line 113

def self.ca_cert_path
  @@ca_cert_path
end

.configure(options) ⇒ Object

# File 'lib/chargebee.rb', line 97

def self.configure(options)
  @@default_env = Environment.new(options)
end

.default_env ⇒ Object

# File 'lib/chargebee.rb', line 101

def self.default_env
  @@default_env
end

.source(source) ⇒ Object

# File 'lib/chargebee.rb', line 117

def self.source(source)
  @@user_agent = @@user_agent + ' ' + source unless source.nil?
end

.update_connect_timeout_secs(connect_timeout) ⇒ Object

# File 'lib/chargebee.rb', line 125

def self.update_connect_timeout_secs(connect_timeout)
  @@default_env.connect_timeout = connect_timeout
end

.update_read_timeout_secs(read_timeout) ⇒ Object

# File 'lib/chargebee.rb', line 129

def self.update_read_timeout_secs(read_timeout)
  @@default_env.read_timeout = read_timeout
end

.user_agent ⇒ Object

# File 'lib/chargebee.rb', line 121

def self.user_agent
  @@user_agent
end

.verify_ca_certs=(verify) ⇒ Object

# File 'lib/chargebee.rb', line 105

def self.verify_ca_certs=(verify)
  @@verify_ca_certs = verify
end

.verify_ca_certs? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/chargebee.rb', line 109

def self.verify_ca_certs?
  @@verify_ca_certs
end