Module: Frame

Extended by:
Forwardable
Defined in:
lib/frame_payments.rb,
lib/frame/util.rb,
lib/frame/error.rb,
lib/frame/version.rb,
lib/frame/list_object.rb,
lib/frame/api_resource.rb,
lib/frame/frame_client.rb,
lib/frame/frame_object.rb,
lib/frame/configuration.rb,
lib/frame/resources/charge.rb,
lib/frame/resources/coupon.rb,
lib/frame/resources/payout.rb,
lib/frame/resources/refund.rb,
lib/frame/resources/account.rb,
lib/frame/resources/billing.rb,
lib/frame/resources/dispute.rb,
lib/frame/resources/invoice.rb,
lib/frame/resources/product.rb,
lib/frame/resources/customer.rb,
lib/frame/resources/discount.rb,
lib/frame/resources/geofence.rb,
lib/frame/resources/transfer.rb,
lib/frame/api_operations/list.rb,
lib/frame/api_operations/save.rb,
lib/frame/resources/capability.rb,
lib/frame/resources/onboarding.rb,
lib/frame/api_operations/create.rb,
lib/frame/api_operations/delete.rb,
lib/frame/api_operations/request.rb,
lib/frame/resources/subscription.rb,
lib/frame/resources/charge_intent.rb,
lib/frame/resources/product_phase.rb,
lib/frame/resources/sonar_session.rb,
lib/frame/resources/charge_session.rb,
lib/frame/resources/payment_method.rb,
lib/frame/resources/promotion_code.rb,
lib/frame/resources/three_ds_intent.rb,
lib/frame/resources/terms_of_service.rb,
lib/frame/resources/webhook_endpoint.rb,
lib/frame/resources/invoice_line_item.rb,
lib/frame/resources/transfer_fee_plan.rb,
lib/frame/resources/onboarding_session.rb,
lib/frame/resources/phone_verification.rb,
lib/frame/resources/subscription_phase.rb,
lib/frame/resources/payment_link_session.rb,
lib/frame/resources/subscription_change_log.rb,
lib/frame/resources/transfer_billing_agreement.rb,
lib/frame/resources/customer_identity_verification.rb

Overview

Main Frame module

The Frame module provides the main interface for interacting with the Frame Payments API. Configure your API key and start making requests:

Frame.api_key = 'your_api_key_here'
customer = Frame::Customer.create(name: 'John Doe', email: 'john@example.com')

See Also:

Defined Under Namespace

Modules: APIOperations, Util Classes: APIConnectionError, APIError, APIResource, Account, AuthenticationError, Billing, Capability, Charge, ChargeIntent, ChargeSession, Configuration, Coupon, Customer, CustomerIdentityVerification, Discount, Dispute, Error, FrameClient, FrameObject, Geofence, InvalidParameterError, InvalidRequestError, Invoice, InvoiceLineItem, ListObject, Onboarding, OnboardingSession, PaymentLinkSession, PaymentMethod, Payout, PhoneVerification, Product, ProductPhase, PromotionCode, RateLimitError, Refund, ResourceNotFoundError, SonarSession, Subscription, SubscriptionChangeLog, SubscriptionPhase, TermsOfService, ThreeDsIntent, Transfer, TransferBillingAgreement, TransferFeePlan, WebhookEndpoint

Constant Summary collapse

VERSION = 
"0.1.2"

Class Attribute Summary collapse

Class Attribute Details

.config ⇒ Configuration (readonly)

Returns the current configuration object.

Returns:



49
50
51
 
# File 'lib/frame_payments.rb', line 49

def config
  @config
end