frame_payments 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 390427c524406aa69715b0bb8edae7e13ff8a07b0744cfee4904a3ed26ab121c
-  data.tar.gz: 5d22279caa8be8244554acbca9bba373018fbfcf7d8c581fa06c77970f474b64
+  metadata.gz: e94011b5aa8edb5c79e9296f38b08d3e9518595c8971cb8debeb0f27cf8d70d7
+  data.tar.gz: 9eeb830eb09c184d5e852b76b06ad52756b84c9b37060987f831c04030517156
 SHA512:
-  metadata.gz: 8d0e7eebd1b8809c134df770e8e6b5b9636fb13af58cdf68c4b37f2e5ddb82b675bfc6bfed3fe0a20f14f5260eeacee2d803ff8a1d8c8c3257add979d895bf81
-  data.tar.gz: 6279b04d112c2ac4ff7b2fa85f9007008f646907e7d07297431a3ea5210844305cb82cc6835ca1f98aa41c7376a26c17191ef040e5c31ff60a82fa7dbf0d7b7f
+  metadata.gz: 671d6d04ddea46ada6f7d35c1ecc4d4e7d878c2e59e552faf646d727d95e26a376a6d62b057dcd8f830d73bab3cc781af37c674935d1156d031e1287fd93fa35
+  data.tar.gz: a736ea705d15942a2e4ed6cede295fdbe95a946d02569896e788e065696c803e828519eaa4cca42ee4bc015bbdb5f519353fc8a218c1a919146bf37aac6eb865

data/README.md

@@ -1,4 +1,4 @@
-# Frame Payments Ruby Library
+# Frame Payments - Ruby SDK
 
 A Ruby library for the Frame Payments API.
 
@@ -133,6 +133,8 @@ charge_intent = Frame::ChargeIntent.create(
 )
 ```
 
+Optional: include `sonar_session_id` (string) when creating a charge intent to link the transaction to a Frame Sonar session for fraud protection (e.g. the value from `frame_charge_session_id` in client storage). See [Frame Sonar documentation](https://docs.framepayments.com/guides/sonar-fraud-protection).
+
 **Retrieve, list, and update:**
 
 ```ruby
@@ -147,13 +149,14 @@ intent.description = 'Updated description'
 intent.save
 ```
 
-**Authorize, capture, or cancel:**
+**Confirm, capture, or cancel:**
 
 ```ruby
 intent = Frame::ChargeIntent.retrieve('ci_123456789')
-intent.authorize  # Authorize the payment
+intent.confirm    # Confirm the payment
 intent.capture    # Capture the authorized amount
 intent.cancel     # Cancel the intent
+intent.void_remaining  # Void any remaining uncaptured amount
 ```
 
 ### Payment Methods
@@ -231,19 +234,11 @@ invoice = Frame::Invoice.create(
 )
 ```
 
-**Manage invoice lifecycle:**
+**Issue an invoice:**
 
 ```ruby
 invoice = Frame::Invoice.retrieve('inv_123456789')
-
-# Finalize (make it payable)
-invoice.finalize
-
-# Mark as paid
-invoice.pay(payment_method: 'pm_123456789')
-
-# Void
-invoice.void
+invoice.issue
 ```
 
 **List invoices:**
@@ -257,8 +252,7 @@ invoices = Frame::Invoice.list(customer: 'cus_123456789', status: 'paid')
 **Create a line item:**
 
 ```ruby
-line_item = Frame::InvoiceLineItem.create(
-  invoice: 'inv_123456789',
+line_item = Frame::InvoiceLineItem.create('inv_123456789',
   description: 'Product or service',
   quantity: 2,
   unit_amount: 5000
@@ -285,18 +279,10 @@ subscription = Frame::Subscription.create(
 )
 ```
 
-**Manage subscription:**
+**Cancel a subscription:**
 
 ```ruby
 subscription = Frame::Subscription.retrieve('sub_123456789')
-
-# Pause
-subscription.pause
-
-# Resume
-subscription.resume
-
-# Cancel
 subscription.cancel
 ```
 
@@ -329,8 +315,7 @@ products = Frame::Product.list(active: true)
 **Create a product phase:**
 
 ```ruby
-phase = Frame::ProductPhase.create(
-  product: 'prod_123456789',
+phase = Frame::ProductPhase.create('prod_123456789',
   price: 10000,
   currency: 'usd',
   interval: 'month',
@@ -373,10 +358,10 @@ verification = Frame::CustomerIdentityVerification.create(
 )
 ```
 
-**Verify:**
+**Upload documents:**
 
 ```ruby
-verification.verify
+verification.upload_documents(documents: [...])
 ```
 
 **List verifications:**

data/lib/frame/resources/account.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Frame
+  class Account < APIResource
+    extend Frame::APIOperations::Create
+    extend Frame::APIOperations::List
+    include Frame::APIOperations::Save
+
+    OBJECT_NAME = "account"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.create(params = {}, opts = {})
+      request_object(:post, "/v1/accounts", params, opts)
+    end
+
+    def self.list(params = {}, opts = {})
+      request_object(:get, "/v1/accounts", params, opts)
+    end
+
+    def self.retrieve(id, opts = {})
+      request_object(:get, "/v1/accounts/#{CGI.escape(id)}", {}, opts)
+    end
+
+    def self.disable(id, params = {}, opts = {})
+      request_object(:delete, "/v1/accounts/#{CGI.escape(id)}", params, opts)
+    end
+
+    def self.search(params = {}, opts = {})
+      request_object(:get, "/v1/accounts/search", params, opts)
+    end
+
+    def self.payment_methods(id, opts = {})
+      request_object(:get, "/v1/accounts/#{CGI.escape(id)}/payment_methods", {}, opts)
+    end
+
+    def self.plaid_link_token(id, opts = {})
+      request_object(:get, "/v1/accounts/#{CGI.escape(id)}/plaid_link_token", {}, opts)
+    end
+
+    def self.restrict(id, opts = {})
+      request_object(:post, "/v1/accounts/#{CGI.escape(id)}/restrict", {}, opts)
+    end
+
+    def self.unrestrict(id, opts = {})
+      request_object(:post, "/v1/accounts/#{CGI.escape(id)}/unrestrict", {}, opts)
+    end
+
+    def self.geo_compliance(id, opts = {})
+      request_object(:get, "/v1/accounts/#{CGI.escape(id)}/geo_compliance", {}, opts)
+    end
+
+    def save(params = {}, opts = {})
+      values = serialize_params(self).merge(params)
+      return self if values.empty?
+      updated = request_object(:patch, "/v1/accounts/#{CGI.escape(self["id"])}", values, opts)
+      initialize_from(updated)
+      self
+    end
+  end
+end

data/lib/frame/resources/billing.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Frame
+  class Billing < APIResource
+    OBJECT_NAME = "billing"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.create_metering(params = {}, opts = {})
+      request_object(:post, "/v1/billing/metering", params, opts)
+    end
+
+    def self.get_metering(id, opts = {})
+      request_object(:get, "/v1/billing/metering/#{CGI.escape(id)}", {}, opts)
+    end
+
+    def self.update_metering(id, params = {}, opts = {})
+      request_object(:patch, "/v1/billing/metering/#{CGI.escape(id)}", params, opts)
+    end
+
+    def self.create_metering_event(params = {}, opts = {})
+      request_object(:post, "/v1/billing/metering_events", params, opts)
+    end
+
+    def self.get_metering_event(id, opts = {})
+      request_object(:get, "/v1/billing/metering_events/#{CGI.escape(id)}", {}, opts)
+    end
+
+    def self.update_metering_event(id, params = {}, opts = {})
+      request_object(:patch, "/v1/billing/metering_events/#{CGI.escape(id)}", params, opts)
+    end
+
+    def self.create_billing_invoice(params = {}, opts = {})
+      request_object(:post, "/v1/billing/billing_invoice", params, opts)
+    end
+
+    def self.create_billing_credit(params = {}, opts = {})
+      request_object(:post, "/v1/billing/billing_credit", params, opts)
+    end
+
+    def self.get_billing_credit(id, opts = {})
+      request_object(:get, "/v1/billing/billing_credit/#{CGI.escape(id)}", {}, opts)
+    end
+
+    def self.customer_report(params = {}, opts = {})
+      request_object(:get, "/v1/billing/report/customer", params, opts)
+    end
+
+    def self.event_report(event_name, params = {}, opts = {})
+      request_object(:get, "/v1/billing/report/event/#{CGI.escape(event_name)}", params, opts)
+    end
+
+    def self.events_report(params = {}, opts = {})
+      request_object(:get, "/v1/billing/report/events", params, opts)
+    end
+
+    def self.subscription_report(params = {}, opts = {})
+      request_object(:get, "/v1/billing/report/subscription", params, opts)
+    end
+  end
+end

data/lib/frame/resources/capability.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Frame
+  class Capability < APIResource
+    OBJECT_NAME = "capability"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.list(account_id, params = {}, opts = {})
+      request_object(:get, "/v1/accounts/#{CGI.escape(account_id)}/capabilities", params, opts)
+    end
+
+    def self.request(account_id, params = {}, opts = {})
+      request_object(:post, "/v1/accounts/#{CGI.escape(account_id)}/capabilities", params, opts)
+    end
+
+    def self.retrieve(account_id, name, opts = {})
+      request_object(:get, "/v1/accounts/#{CGI.escape(account_id)}/capabilities/#{CGI.escape(name)}", {}, opts)
+    end
+
+    def self.disable(account_id, name, params = {}, opts = {})
+      request_object(:delete, "/v1/accounts/#{CGI.escape(account_id)}/capabilities/#{CGI.escape(name)}", params, opts)
+    end
+  end
+end

data/lib/frame/resources/charge.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Frame
+  class Charge < APIResource
+    OBJECT_NAME = "charge"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.retrieve(id, opts = {})
+      request_object(:get, "/v1/charges/#{CGI.escape(id)}", {}, opts)
+    end
+
+    def self.trace(id, opts = {})
+      request_object(:get, "/v1/charges/#{CGI.escape(id)}/trace", {}, opts)
+    end
+  end
+end

data/lib/frame/resources/charge_intent.rb

@@ -40,19 +40,19 @@ module Frame
       )
     end
 
-    def authorize(params = {}, opts = {})
+    def confirm(params = {}, opts = {})
       request_object(
         :post,
-        "/v1/charge_intents/#{CGI.escape(self["id"])}/authorize",
+        "/v1/charge_intents/#{CGI.escape(self["id"])}/confirm",
         params,
         opts
       )
     end
 
-    def self.authorize(id, params = {}, opts = {})
+    def self.confirm(id, params = {}, opts = {})
       request_object(
         :post,
-        "/v1/charge_intents/#{CGI.escape(id)}/authorize",
+        "/v1/charge_intents/#{CGI.escape(id)}/confirm",
         params,
         opts
       )
@@ -94,6 +94,24 @@ module Frame
       )
     end
 
+    def void_remaining(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/charge_intents/#{CGI.escape(self["id"])}/void_remaining",
+        params,
+        opts
+      )
+    end
+
+    def self.void_remaining(id, params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/charge_intents/#{CGI.escape(id)}/void_remaining",
+        params,
+        opts
+      )
+    end
+
     def save(params = {}, opts = {})
       values = serialize_params(self).merge(params)
 

data/lib/frame/resources/charge_session.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Frame
+  class ChargeSession < APIResource
+    include Frame::APIOperations::Save
+
+    OBJECT_NAME = "charge_session"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.create(params = {}, opts = {})
+      request_object(:post, "/v1/charge_sessions", params, opts)
+    end
+
+    def self.update(id, params = {}, opts = {})
+      request_object(:patch, "/v1/charge_sessions/#{CGI.escape(id)}", params, opts)
+    end
+
+    def save(params = {}, opts = {})
+      values = serialize_params(self).merge(params)
+      return self if values.empty?
+      updated = request_object(:patch, "/v1/charge_sessions/#{CGI.escape(self["id"])}", values, opts)
+      initialize_from(updated)
+      self
+    end
+  end
+end

data/lib/frame/resources/coupon.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Frame
+  class Coupon < APIResource
+    include Frame::APIOperations::Save
+
+    OBJECT_NAME = "coupon"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.create(params = {}, opts = {})
+      request_object(:post, "/v1/coupons", params, opts)
+    end
+
+    def self.list(params = {}, opts = {})
+      request_object(:get, "/v1/coupons", params, opts)
+    end
+
+    def self.retrieve(id, opts = {})
+      request_object(:get, "/v1/coupons/#{CGI.escape(id)}", {}, opts)
+    end
+
+    def save(params = {}, opts = {})
+      values = serialize_params(self).merge(params)
+      return self if values.empty?
+      updated = request_object(:patch, "/v1/coupons/#{CGI.escape(self["id"])}", values, opts)
+      initialize_from(updated)
+      self
+    end
+  end
+end

data/lib/frame/resources/customer.rb

@@ -95,6 +95,15 @@ module Frame
       )
     end
 
+    def self.payment_methods(id, opts = {})
+      request_object(
+        :get,
+        "/v1/customers/#{CGI.escape(id)}/payment_methods",
+        {},
+        opts
+      )
+    end
+
     def save(params = {}, opts = {})
       values = serialize_params(self).merge(params)
 

data/lib/frame/resources/customer_identity_verification.rb

@@ -39,19 +39,19 @@ module Frame
       )
     end
 
-    def verify(params = {}, opts = {})
+    def upload_documents(params = {}, opts = {})
       request_object(
         :post,
-        "/v1/customer_identity_verifications/#{CGI.escape(self["id"])}/verify",
+        "/v1/customer_identity_verifications/#{CGI.escape(self["id"])}/upload_documents",
         params,
         opts
       )
     end
 
-    def self.verify(id, params = {}, opts = {})
+    def self.upload_documents(id, params = {}, opts = {})
       request_object(
         :post,
-        "/v1/customer_identity_verifications/#{CGI.escape(id)}/verify",
+        "/v1/customer_identity_verifications/#{CGI.escape(id)}/upload_documents",
         params,
         opts
       )

data/lib/frame/resources/discount.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Frame
+  class Discount < APIResource
+    OBJECT_NAME = "discount"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.list(params = {}, opts = {})
+      request_object(:get, "/v1/discounts", params, opts)
+    end
+
+    def self.retrieve(id, opts = {})
+      request_object(:get, "/v1/discounts/#{CGI.escape(id)}", {}, opts)
+    end
+
+    def self.validate(params = {}, opts = {})
+      request_object(:post, "/v1/discounts/validate", params, opts)
+    end
+  end
+end

data/lib/frame/resources/dispute.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Frame
+  class Dispute < APIResource
+    include Frame::APIOperations::Save
+
+    OBJECT_NAME = "dispute"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.list(params = {}, opts = {})
+      request_object(:get, "/v1/disputes", params, opts)
+    end
+
+    def self.retrieve(id, opts = {})
+      request_object(:get, "/v1/disputes/#{CGI.escape(id)}", {}, opts)
+    end
+
+    def self.update(id, params = {}, opts = {})
+      request_object(:patch, "/v1/disputes/#{CGI.escape(id)}", params, opts)
+    end
+
+    def save(params = {}, opts = {})
+      values = serialize_params(self).merge(params)
+      return self if values.empty?
+      updated = request_object(:patch, "/v1/disputes/#{CGI.escape(self["id"])}", values, opts)
+      initialize_from(updated)
+      self
+    end
+
+    def create_document(params = {}, opts = {})
+      request_object(:post, "/v1/disputes/#{CGI.escape(self["id"])}/documents", params, opts)
+    end
+
+    def self.create_document(id, params = {}, opts = {})
+      request_object(:post, "/v1/disputes/#{CGI.escape(id)}/documents", params, opts)
+    end
+  end
+end

data/lib/frame/resources/geofence.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Frame
+  class Geofence < APIResource
+    OBJECT_NAME = "geofence"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.list(params = {}, opts = {})
+      request_object(:get, "/v1/geofences", params, opts)
+    end
+  end
+end

data/lib/frame/resources/invoice.rb

@@ -77,55 +77,19 @@ module Frame
       )
     end
 
-    def finalize(params = {}, opts = {})
+    def issue(params = {}, opts = {})
       request_object(
         :post,
-        "/v1/invoices/#{CGI.escape(self["id"])}/finalize",
+        "/v1/invoices/#{CGI.escape(self["id"])}/issue",
         params,
         opts
       )
     end
 
-    def self.finalize(id, params = {}, opts = {})
+    def self.issue(id, params = {}, opts = {})
       request_object(
         :post,
-        "/v1/invoices/#{CGI.escape(id)}/finalize",
-        params,
-        opts
-      )
-    end
-
-    def pay(params = {}, opts = {})
-      request_object(
-        :post,
-        "/v1/invoices/#{CGI.escape(self["id"])}/pay",
-        params,
-        opts
-      )
-    end
-
-    def self.pay(id, params = {}, opts = {})
-      request_object(
-        :post,
-        "/v1/invoices/#{CGI.escape(id)}/pay",
-        params,
-        opts
-      )
-    end
-
-    def void(params = {}, opts = {})
-      request_object(
-        :post,
-        "/v1/invoices/#{CGI.escape(self["id"])}/void",
-        params,
-        opts
-      )
-    end
-
-    def self.void(id, params = {}, opts = {})
-      request_object(
-        :post,
-        "/v1/invoices/#{CGI.escape(id)}/void",
+        "/v1/invoices/#{CGI.escape(id)}/issue",
         params,
         opts
       )

data/lib/frame/resources/invoice_line_item.rb

@@ -13,38 +13,37 @@ module Frame
       OBJECT_NAME
     end
 
-    def self.create(params = {}, opts = {})
+    def self.create(invoice_id, params = {}, opts = {})
       request_object(
         :post,
-        "/v1/invoice_line_items",
+        "/v1/invoices/#{CGI.escape(invoice_id)}/line_items",
         params,
         opts
       )
     end
 
-    def self.list(params = {}, opts = {})
+    def self.list(invoice_id, params = {}, opts = {})
       request_object(
         :get,
-        "/v1/invoice_line_items",
+        "/v1/invoices/#{CGI.escape(invoice_id)}/line_items",
         params,
         opts
       )
     end
 
-    def self.retrieve(id, opts = {})
-      id = Util.normalize_id(id)
+    def self.retrieve(invoice_id, id, opts = {})
       request_object(
         :get,
-        "/v1/invoice_line_items/#{CGI.escape(id)}",
+        "/v1/invoices/#{CGI.escape(invoice_id)}/line_items/#{CGI.escape(id)}",
         {},
         opts
       )
     end
 
-    def self.delete(id, params = {}, opts = {})
+    def self.delete(invoice_id, id, params = {}, opts = {})
       request_object(
         :delete,
-        "/v1/invoice_line_items/#{CGI.escape(id)}",
+        "/v1/invoices/#{CGI.escape(invoice_id)}/line_items/#{CGI.escape(id)}",
         params,
         opts
       )
@@ -59,7 +58,7 @@ module Frame
 
       updated = request_object(
         :patch,
-        "/v1/invoice_line_items/#{CGI.escape(self["id"])}",
+        "/v1/invoices/#{CGI.escape(self["invoice"])}/line_items/#{CGI.escape(self["id"])}",
         values,
         opts
       )
@@ -71,7 +70,7 @@ module Frame
     def delete(params = {}, opts = {})
       request_object(
         :delete,
-        "/v1/invoice_line_items/#{CGI.escape(self["id"])}",
+        "/v1/invoices/#{CGI.escape(self["invoice"])}/line_items/#{CGI.escape(self["id"])}",
         params,
         opts
       )

data/lib/frame/resources/onboarding.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Frame
+  class Onboarding < APIResource
+    OBJECT_NAME = "onboarding_session"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.list(params = {}, opts = {})
+      request_object(:get, "/v1/onboarding/sessions", params, opts)
+    end
+
+    def self.create(params = {}, opts = {})
+      request_object(:post, "/v1/onboarding/sessions", params, opts)
+    end
+
+    def self.retrieve(session_id, opts = {})
+      request_object(:get, "/v1/onboarding/sessions/#{CGI.escape(session_id)}", {}, opts)
+    end
+
+    def self.update(session_id, params = {}, opts = {})
+      request_object(:patch, "/v1/onboarding/sessions/#{CGI.escape(session_id)}", params, opts)
+    end
+
+    def self.payout(session_id, params = {}, opts = {})
+      request_object(:post, "/v1/onboarding/sessions/#{CGI.escape(session_id)}/payout", params, opts)
+    end
+  end
+end