frame_payments 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e94011b5aa8edb5c79e9296f38b08d3e9518595c8971cb8debeb0f27cf8d70d7
-  data.tar.gz: 9eeb830eb09c184d5e852b76b06ad52756b84c9b37060987f831c04030517156
+  metadata.gz: 627ffb510c44034cb3444cf84429907ac50f9a03dcba464e0a1253fac805fa78
+  data.tar.gz: 74846ed872e992c4c445201b0b3d4b5d805752aeec2949ec2d098abae868e1a0
 SHA512:
-  metadata.gz: 671d6d04ddea46ada6f7d35c1ecc4d4e7d878c2e59e552faf646d727d95e26a376a6d62b057dcd8f830d73bab3cc781af37c674935d1156d031e1287fd93fa35
-  data.tar.gz: a736ea705d15942a2e4ed6cede295fdbe95a946d02569896e788e065696c803e828519eaa4cca42ee4bc015bbdb5f519353fc8a218c1a919146bf37aac6eb865
+  metadata.gz: be5a1d3fa63d8be4c21c70b4891e69cd1fd3f584e541e94b4a55892a10b4ca556b852ffa180c7c21282052fd16e5ed407446dc099ad9261227fb29c6c67802b1
+  data.tar.gz: d3a5dd3a84b29feda5538123ea9633b863349ab7712c3018c7b36e139800db589db2c45deb82fe3350ce53d47d78c885bbbdbb089c650ee991bf700815140dcc

data/Rakefile

@@ -8,3 +8,10 @@ Minitest::TestTask.create
 require "standard/rake"
 
 task default: %i[test standard]
+
+# Regenerate the SDK surface manifest consumed by the cross-SDK conformance
+# audit (FRA-4516 producer / FRA-4457 consumer).
+desc "Generate the surface manifest (surface-manifest.json)"
+task :surface_manifest do
+  sh File.expand_path("bin/generate-surface-manifest", __dir__)
+end

data/lib/frame/resources/account.rb

@@ -12,6 +12,8 @@ module Frame
       OBJECT_NAME
     end
 
+    DEPRECATED_METHODS = %i[geo_compliance].freeze
+
     def self.create(params = {}, opts = {})
       request_object(:post, "/v1/accounts", params, opts)
     end
@@ -24,6 +26,10 @@ module Frame
       request_object(:get, "/v1/accounts/#{CGI.escape(id)}", {}, opts)
     end
 
+    def self.update(id, params = {}, opts = {})
+      request_object(:patch, "/v1/accounts/#{CGI.escape(id)}", params, opts)
+    end
+
     def self.disable(id, params = {}, opts = {})
       request_object(:delete, "/v1/accounts/#{CGI.escape(id)}", params, opts)
     end
@@ -48,6 +54,15 @@ module Frame
       request_object(:post, "/v1/accounts/#{CGI.escape(id)}/unrestrict", {}, opts)
     end
 
+    def self.get_geo_compliance(id, opts = {})
+      request_object(:get, "/v1/accounts/#{CGI.escape(id)}/geo_compliance", {}, opts)
+    end
+
+    def self.confirm_kyc_prefill(id, opts = {})
+      request_object(:post, "/v1/accounts/#{CGI.escape(id)}/kyc_prefill/confirm", {}, opts)
+    end
+
+    # @deprecated Use `get_geo_compliance` instead. Removed at v2.
     def self.geo_compliance(id, opts = {})
       request_object(:get, "/v1/accounts/#{CGI.escape(id)}/geo_compliance", {}, opts)
     end

data/lib/frame/resources/bank_account.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Frame
+  class BankAccount < APIResource
+    extend Frame::APIOperations::Create
+
+    OBJECT_NAME = "bank_account"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.create(params = {}, opts = {})
+      request_object(:post, "/v1/bank_accounts", params, opts)
+    end
+  end
+end

data/lib/frame/resources/beneficial_owner.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Frame
+  class BeneficialOwner < APIResource
+    OBJECT_NAME = "beneficial_owner"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.list(account_id, params = {}, opts = {})
+      request_object(:get, "/v1/accounts/#{CGI.escape(account_id)}/beneficial_owners", params, opts)
+    end
+
+    def self.create(account_id, params = {}, opts = {})
+      request_object(:post, "/v1/accounts/#{CGI.escape(account_id)}/beneficial_owners", params, opts)
+    end
+
+    def self.retrieve(account_id, id, opts = {})
+      request_object(:get, "/v1/accounts/#{CGI.escape(account_id)}/beneficial_owners/#{CGI.escape(id)}", {}, opts)
+    end
+
+    def self.update(account_id, id, params = {}, opts = {})
+      request_object(:patch, "/v1/accounts/#{CGI.escape(account_id)}/beneficial_owners/#{CGI.escape(id)}", params, opts)
+    end
+
+    def self.delete(account_id, id, params = {}, opts = {})
+      request_object(:delete, "/v1/accounts/#{CGI.escape(account_id)}/beneficial_owners/#{CGI.escape(id)}", params, opts)
+    end
+
+    def self.confirm_roster(account_id, params = {}, opts = {})
+      request_object(:post, "/v1/accounts/#{CGI.escape(account_id)}/beneficial_owners/confirm", params, opts)
+    end
+
+    def self.resend_invite(account_id, id, params = {}, opts = {})
+      request_object(:post, "/v1/accounts/#{CGI.escape(account_id)}/beneficial_owners/#{CGI.escape(id)}/resend_invite", params, opts)
+    end
+  end
+end

data/lib/frame/resources/billing.rb

@@ -8,6 +8,8 @@ module Frame
       OBJECT_NAME
     end
 
+    DEPRECATED_METHODS = %i[customer_report event_report events_report subscription_report].freeze
+
     def self.create_metering(params = {}, opts = {})
       request_object(:post, "/v1/billing/metering", params, opts)
     end
@@ -44,20 +46,44 @@ module Frame
       request_object(:get, "/v1/billing/billing_credit/#{CGI.escape(id)}", {}, opts)
     end
 
+    def self.get_customer_report(params = {}, opts = {})
+      request_object(:get, "/v1/billing/report/customer", params, opts)
+    end
+
+    # @deprecated Use `get_customer_report` instead. Removed at v2.
     def self.customer_report(params = {}, opts = {})
       request_object(:get, "/v1/billing/report/customer", params, opts)
     end
 
+    def self.get_event_report(event_name, params = {}, opts = {})
+      request_object(:get, "/v1/billing/report/event/#{CGI.escape(event_name)}", params, opts)
+    end
+
+    # @deprecated Use `get_event_report` instead. Removed at v2.
     def self.event_report(event_name, params = {}, opts = {})
       request_object(:get, "/v1/billing/report/event/#{CGI.escape(event_name)}", params, opts)
     end
 
+    def self.get_events_report(params = {}, opts = {})
+      request_object(:get, "/v1/billing/report/events", params, opts)
+    end
+
+    # @deprecated Use `get_events_report` instead. Removed at v2.
     def self.events_report(params = {}, opts = {})
       request_object(:get, "/v1/billing/report/events", params, opts)
     end
 
+    def self.get_subscription_report(params = {}, opts = {})
+      request_object(:get, "/v1/billing/report/subscription", params, opts)
+    end
+
+    # @deprecated Use `get_subscription_report` instead. Removed at v2.
     def self.subscription_report(params = {}, opts = {})
       request_object(:get, "/v1/billing/report/subscription", params, opts)
     end
+
+    def self.threshold_progress_report(params = {}, opts = {})
+      request_object(:get, "/v1/billing/report/threshold_progress", params, opts)
+    end
   end
 end

data/lib/frame/resources/charge_intent.rb

@@ -12,6 +12,9 @@ module Frame
       OBJECT_NAME
     end
 
+    DEPRECATED_METHODS = %i[create retrieve list confirm capture cancel void_remaining save].freeze
+
+    # @deprecated Use Frame::Transfer.create instead. Removed at v2.
     def self.create(params = {}, opts = {})
       request_object(
         :post,
@@ -21,6 +24,7 @@ module Frame
       )
     end
 
+    # @deprecated Use Frame::Transfer.list instead. Removed at v2.
     def self.list(params = {}, opts = {})
       request_object(
         :get,
@@ -30,6 +34,7 @@ module Frame
       )
     end
 
+    # @deprecated Use Frame::Transfer.retrieve instead. Removed at v2.
     def self.retrieve(id, opts = {})
       id = Util.normalize_id(id)
       request_object(
@@ -40,6 +45,7 @@ module Frame
       )
     end
 
+    # @deprecated Use Frame::Transfer.confirm instead. Removed at v2.
     def confirm(params = {}, opts = {})
       request_object(
         :post,
@@ -49,6 +55,7 @@ module Frame
       )
     end
 
+    # @deprecated Use Frame::Transfer.confirm instead. Removed at v2.
     def self.confirm(id, params = {}, opts = {})
       request_object(
         :post,
@@ -58,6 +65,7 @@ module Frame
       )
     end
 
+    # @deprecated Removed at v2. No canonical transfer equivalent yet (FRA-4463).
     def capture(params = {}, opts = {})
       request_object(
         :post,
@@ -67,6 +75,7 @@ module Frame
       )
     end
 
+    # @deprecated Removed at v2. No canonical transfer equivalent yet (FRA-4463).
     def self.capture(id, params = {}, opts = {})
       request_object(
         :post,
@@ -76,6 +85,7 @@ module Frame
       )
     end
 
+    # @deprecated Removed at v2. No canonical transfer equivalent yet (FRA-4463).
     def cancel(params = {}, opts = {})
       request_object(
         :post,
@@ -85,6 +95,7 @@ module Frame
       )
     end
 
+    # @deprecated Removed at v2. No canonical transfer equivalent yet (FRA-4463).
     def self.cancel(id, params = {}, opts = {})
       request_object(
         :post,
@@ -94,6 +105,7 @@ module Frame
       )
     end
 
+    # @deprecated Removed at v2. No canonical transfer equivalent yet (FRA-4463).
     def void_remaining(params = {}, opts = {})
       request_object(
         :post,
@@ -103,6 +115,7 @@ module Frame
       )
     end
 
+    # @deprecated Removed at v2. No canonical transfer equivalent yet (FRA-4463).
     def self.void_remaining(id, params = {}, opts = {})
       request_object(
         :post,
@@ -112,6 +125,7 @@ module Frame
       )
     end
 
+    # @deprecated Removed at v2. No canonical transfer equivalent yet (FRA-4463).
     def save(params = {}, opts = {})
       values = serialize_params(self).merge(params)
 

data/lib/frame/resources/coupon.rb

@@ -22,6 +22,10 @@ module Frame
       request_object(:get, "/v1/coupons/#{CGI.escape(id)}", {}, opts)
     end
 
+    def self.update(id, params = {}, opts = {})
+      request_object(:patch, "/v1/coupons/#{CGI.escape(id)}", params, opts)
+    end
+
     def save(params = {}, opts = {})
       values = serialize_params(self).merge(params)
       return self if values.empty?

data/lib/frame/resources/customer.rb

@@ -13,6 +13,11 @@ module Frame
       OBJECT_NAME
     end
 
+    # Customers are deprecated in favor of Accounts (M2 demotion). Only methods
+    # with a clear cross-resource target are demoted; create/retrieve/list/
+    # search/save stay non-deprecated pending an unambiguous mapping.
+    DEPRECATED_METHODS = %i[delete block unblock payment_methods].freeze
+
     def self.create(params = {}, opts = {})
       request_object(
         :post,
@@ -50,6 +55,7 @@ module Frame
       )
     end
 
+    # @deprecated Use `Account.disable` instead. Removed at v2.
     def self.delete(id, params = {}, opts = {})
       request_object(
         :delete,
@@ -59,6 +65,7 @@ module Frame
       )
     end
 
+    # @deprecated Account.block pending a monolith route; no re-route yet. Removed at v2.
     def block(params = {}, opts = {})
       request_object(
         :post,
@@ -68,6 +75,7 @@ module Frame
       )
     end
 
+    # @deprecated Account.block pending a monolith route; no re-route yet. Removed at v2.
     def self.block(id, params = {}, opts = {})
       request_object(
         :post,
@@ -77,6 +85,7 @@ module Frame
       )
     end
 
+    # @deprecated Account.unblock pending a monolith route; no re-route yet. Removed at v2.
     def unblock(params = {}, opts = {})
       request_object(
         :post,
@@ -86,6 +95,7 @@ module Frame
       )
     end
 
+    # @deprecated Account.unblock pending a monolith route; no re-route yet. Removed at v2.
     def self.unblock(id, params = {}, opts = {})
       request_object(
         :post,
@@ -95,6 +105,7 @@ module Frame
       )
     end
 
+    # @deprecated Use `PaymentMethod.list(account_id:)` instead (FRA-4461). Removed at v2.
     def self.payment_methods(id, opts = {})
       request_object(
         :get,
@@ -122,6 +133,7 @@ module Frame
       self
     end
 
+    # @deprecated Use `Account.disable` instead. Removed at v2.
     def delete(params = {}, opts = {})
       request_object(
         :delete,

data/lib/frame/resources/customer_identity_verification.rb

@@ -11,6 +11,12 @@ module Frame
       OBJECT_NAME
     end
 
+    # Methods deprecated for removal at v2. `list` has no backing route (the
+    # monolith exposes customer_identity_verifications only as [:create, :show];
+    # there is no index action / public list endpoint), so it is a no-op that
+    # 404s — kept only so existing callers don't NoMethodError before v2.
+    DEPRECATED_METHODS = %i[list].freeze
+
     def self.create(params = {}, opts = {})
       request_object(
         :post,
@@ -20,6 +26,23 @@ module Frame
       )
     end
 
+    # Create an identity verification for an existing customer.
+    # POST /v1/customer_identity_verifications/{customer_id}
+    # (monolith customer_identity_verifications#create_from_customer).
+    # The documented route takes only the customer_id path param — no request
+    # body — so no params argument is exposed.
+    def self.create_for_customer(customer_id, opts = {})
+      customer_id = Util.normalize_id(customer_id)
+      request_object(
+        :post,
+        "/v1/customer_identity_verifications/#{CGI.escape(customer_id)}",
+        {},
+        opts
+      )
+    end
+
+    # @deprecated No public list endpoint exists for this resource; this 404s.
+    #   Removed at v2. See DEPRECATED_METHODS.
     def self.list(params = {}, opts = {})
       request_object(
         :get,

data/lib/frame/resources/invoice.rb

@@ -41,6 +41,15 @@ module Frame
       )
     end
 
+    def self.update(id, params = {}, opts = {})
+      request_object(
+        :patch,
+        "/v1/invoices/#{CGI.escape(id)}",
+        params,
+        opts
+      )
+    end
+
     def self.delete(id, params = {}, opts = {})
       request_object(
         :delete,

data/lib/frame/resources/invoice_line_item.rb

@@ -40,6 +40,15 @@ module Frame
       )
     end
 
+    def self.update(invoice_id, id, params = {}, opts = {})
+      request_object(
+        :patch,
+        "/v1/invoices/#{CGI.escape(invoice_id)}/line_items/#{CGI.escape(id)}",
+        params,
+        opts
+      )
+    end
+
     def self.delete(invoice_id, id, params = {}, opts = {})
       request_object(
         :delete,

data/lib/frame/resources/merchant_balance.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Frame
+  # Top-level singleton: the authenticated merchant's balance (available funds,
+  # reserved amounts, pending payouts). GET /v1/merchant_balance — no id.
+  class MerchantBalance < APIResource
+    OBJECT_NAME = "merchant_balance"
+
+    def self.object_name
+      OBJECT_NAME
+    end
+
+    def self.retrieve(opts = {})
+      request_object(:get, "/v1/merchant_balance", {}, opts)
+    end
+  end
+end

data/lib/frame/resources/onboarding_session.rb

@@ -15,5 +15,13 @@ module Frame
     def self.list(params = {}, opts = {})
       request_object(:get, "/v1/onboarding_sessions", params, opts)
     end
+
+    # Bootstrap the embedded onboarding Web Component from a client_secret.
+    # GET /v1/onboarding_sessions/bootstrap — authenticate with the onb_sess_*
+    # token (pass via opts). Returns session metadata, the ordered step list,
+    # and full account context in one call.
+    def self.bootstrap(opts = {})
+      request_object(:get, "/v1/onboarding_sessions/bootstrap", {}, opts)
+    end
   end
 end

data/lib/frame/resources/payment_method.rb

@@ -21,6 +21,42 @@ module Frame
       )
     end
 
+    def self.create_card(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/payment_methods",
+        params,
+        opts
+      )
+    end
+
+    def self.create_bank_account(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/payment_methods",
+        params,
+        opts
+      )
+    end
+
+    def self.create_apple_pay(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/payment_methods",
+        params,
+        opts
+      )
+    end
+
+    def self.create_google_pay(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/payment_methods",
+        params,
+        opts
+      )
+    end
+
     def self.list(params = {}, opts = {})
       request_object(
         :get,
@@ -40,6 +76,15 @@ module Frame
       )
     end
 
+    def self.update(id, params = {}, opts = {})
+      request_object(
+        :patch,
+        "/v1/payment_methods/#{CGI.escape(id)}",
+        params,
+        opts
+      )
+    end
+
     def self.connect_plaid(params = {}, opts = {})
       request_object(
         :post,

data/lib/frame/resources/payout.rb

@@ -8,6 +8,11 @@ module Frame
       OBJECT_NAME
     end
 
+    # `retrieve` is inherited from APIResource but the payout vocabulary is
+    # `create` only — the API exposes no `GET /v1/payouts/{id}` endpoint.
+    # Flag it deprecated so it stays out of the parity denominator; removed at v2.
+    DEPRECATED_METHODS = %i[retrieve].freeze
+
     def self.create(params = {}, opts = {})
       request_object(:post, "/v1/payouts", params, opts)
     end

data/lib/frame/resources/phone_verification.rb

@@ -8,6 +8,12 @@ module Frame
       OBJECT_NAME
     end
 
+    # `retrieve` is inherited from APIResource but the API exposes no
+    # `GET /phone_verifications/{id}` endpoint — the canonical surface is
+    # create + confirm only. Flag it deprecated so it stays out of the parity
+    # denominator; removed at v2.
+    DEPRECATED_METHODS = %i[retrieve].freeze
+
     def self.create(account_id, params = {}, opts = {})
       request_object(:post, "/v1/accounts/#{CGI.escape(account_id)}/phone_verifications", params, opts)
     end

data/lib/frame/resources/product.rb

@@ -50,6 +50,15 @@ module Frame
       )
     end
 
+    def self.update(id, params = {}, opts = {})
+      request_object(
+        :patch,
+        "/v1/products/#{CGI.escape(id)}",
+        params,
+        opts
+      )
+    end
+
     def self.delete(id, params = {}, opts = {})
       request_object(
         :delete,

data/lib/frame/resources/product_phase.rb

@@ -40,6 +40,15 @@ module Frame
       )
     end
 
+    def self.update(product_id, id, params = {}, opts = {})
+      request_object(
+        :patch,
+        "/v1/products/#{CGI.escape(product_id)}/phases/#{CGI.escape(id)}",
+        params,
+        opts
+      )
+    end
+
     def self.bulk_update(product_id, phases, opts = {})
       request_object(
         :patch,

data/lib/frame/resources/promotion_code.rb

@@ -22,6 +22,10 @@ module Frame
       request_object(:get, "/v1/promotion_codes/#{CGI.escape(id)}", {}, opts)
     end
 
+    def self.update(id, params = {}, opts = {})
+      request_object(:patch, "/v1/promotion_codes/#{CGI.escape(id)}", params, opts)
+    end
+
     def save(params = {}, opts = {})
       values = serialize_params(self).merge(params)
       return self if values.empty?

data/lib/frame/resources/subscription.rb

@@ -4,7 +4,6 @@ module Frame
   class Subscription < APIResource
     extend Frame::APIOperations::Create
     extend Frame::APIOperations::List
-    include Frame::APIOperations::Delete
     include Frame::APIOperations::Save
 
     OBJECT_NAME = "subscription"
@@ -41,15 +40,24 @@ module Frame
       )
     end
 
-    def self.delete(id, params = {}, opts = {})
+    def self.update(id, params = {}, opts = {})
       request_object(
-        :delete,
+        :patch,
         "/v1/subscriptions/#{CGI.escape(id)}",
         params,
         opts
       )
     end
 
+    def self.search(params = {}, opts = {})
+      request_object(
+        :get,
+        "/v1/subscriptions/search",
+        params,
+        opts
+      )
+    end
+
     def save(params = {}, opts = {})
       values = serialize_params(self).merge(params)
 
@@ -68,19 +76,28 @@ module Frame
       self
     end
 
-    def delete(params = {}, opts = {})
+    def cancel(params = {}, opts = {})
       request_object(
-        :delete,
-        "/v1/subscriptions/#{CGI.escape(self["id"])}",
+        :post,
+        "/v1/subscriptions/#{CGI.escape(self["id"])}/cancel",
         params,
         opts
       )
     end
 
-    def cancel(params = {}, opts = {})
+    def pause(params = {}, opts = {})
       request_object(
         :post,
-        "/v1/subscriptions/#{CGI.escape(self["id"])}/cancel",
+        "/v1/subscriptions/#{CGI.escape(self["id"])}/pause",
+        params,
+        opts
+      )
+    end
+
+    def resume(params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/subscriptions/#{CGI.escape(self["id"])}/resume",
         params,
         opts
       )
@@ -94,5 +111,23 @@ module Frame
         opts
       )
     end
+
+    def self.pause(id, params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/subscriptions/#{CGI.escape(id)}/pause",
+        params,
+        opts
+      )
+    end
+
+    def self.resume(id, params = {}, opts = {})
+      request_object(
+        :post,
+        "/v1/subscriptions/#{CGI.escape(id)}/resume",
+        params,
+        opts
+      )
+    end
   end
 end

data/lib/frame/resources/subscription_phase.rb

@@ -40,6 +40,15 @@ module Frame
       )
     end
 
+    def self.update(subscription_id, id, params = {}, opts = {})
+      request_object(
+        :patch,
+        "/v1/subscriptions/#{CGI.escape(subscription_id)}/phases/#{CGI.escape(id)}",
+        params,
+        opts
+      )
+    end
+
     def self.bulk_update(subscription_id, phases, opts = {})
       request_object(
         :patch,