stripe 12.7.0.pre.beta.2 → 13.1.0.pre.beta.2

data/lib/stripe/services/financial_connections/account_service.rb

@@ -0,0 +1,83 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountService < StripeService
+      attr_reader :inferred_balances, :owners
+
+      def initialize(requestor)
+        super(requestor)
+        @inferred_balances = Stripe::FinancialConnections::AccountInferredBalanceService
+                             .new(@requestor)
+        @owners = Stripe::FinancialConnections::AccountOwnerService.new(@requestor)
+      end
+
+      # Disables your access to a Financial Connections Account. You will no longer be able to access data associated with the account (e.g. balances, transactions).
+      def disconnect(account, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/disconnect", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of Financial Connections Account objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/financial_connections/accounts",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Refreshes the data associated with a Financial Connections Account.
+      def refresh(account, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/refresh", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of an Financial Connections Account.
+      def retrieve(account, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Subscribes to periodic refreshes of data associated with a Financial Connections Account.
+      def subscribe(account, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/subscribe", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.
+      def unsubscribe(account, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/financial_connections/accounts/%<account>s/unsubscribe", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/financial_connections/institution_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class InstitutionService < StripeService
+      # Returns a list of Financial Connections Institution objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/financial_connections/institutions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Financial Connections Institution.
+      def retrieve(institution, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/institutions/%<institution>s", { institution: CGI.escape(institution) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/financial_connections/session_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class SessionService < StripeService
+      # To launch the Financial Connections authorization flow, create a Session. The session's client_secret can be used to launch the flow using Stripe.js.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/financial_connections/sessions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Financial Connections Session
+      def retrieve(session, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/sessions/%<session>s", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/financial_connections/transaction_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class TransactionService < StripeService
+      # Returns a list of Financial Connections Transaction objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/financial_connections/transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Financial Connections Transaction
+      def retrieve(transaction, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/transactions/%<transaction>s", { transaction: CGI.escape(transaction) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/financial_connections_service.rb

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FinancialConnectionsService < StripeService
+    attr_reader :accounts, :institutions, :sessions, :transactions
+
+    def initialize(requestor)
+      super(requestor)
+      @accounts = Stripe::FinancialConnections::AccountService.new(@requestor)
+      @institutions = Stripe::FinancialConnections::InstitutionService.new(@requestor)
+      @sessions = Stripe::FinancialConnections::SessionService.new(@requestor)
+      @transactions = Stripe::FinancialConnections::TransactionService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/forwarding/request_service.rb

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Forwarding
+    class RequestService < StripeService
+      # Creates a ForwardingRequest object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/forwarding/requests",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Lists all ForwardingRequest objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/forwarding/requests",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a ForwardingRequest object.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/forwarding/requests/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/forwarding_service.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ForwardingService < StripeService
+    attr_reader :requests
+
+    def initialize(requestor)
+      super(requestor)
+      @requests = Stripe::Forwarding::RequestService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/gift_cards/card_service.rb

@@ -0,0 +1,63 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    class CardService < StripeService
+      # Creates a new gift card object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/gift_cards/cards",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # List gift cards for an account
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/gift_cards/cards",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve a gift card by id
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Update a gift card
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Validates a gift card code, returning the matching gift card object if it exists.
+      def validate(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/gift_cards/cards/validate",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/gift_cards/transaction_service.rb

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    class TransactionService < StripeService
+      # Cancel a gift card transaction
+      def cancel(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Confirm a gift card transaction
+      def confirm(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Create a gift card transaction
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/gift_cards/transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # List gift card transactions for a gift card
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/gift_cards/transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the gift card transaction.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Update a gift card transaction
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/gift_cards_service.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardsService < StripeService
+    attr_reader :cards, :transactions
+
+    def initialize(requestor)
+      super(requestor)
+      @cards = Stripe::GiftCards::CardService.new(@requestor)
+      @transactions = Stripe::GiftCards::TransactionService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/identity/verification_report_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationReportService < StripeService
+      # List all verification reports.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/identity/verification_reports",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves an existing VerificationReport
+      def retrieve(report, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/identity/verification_reports/%<report>s", { report: CGI.escape(report) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/identity/verification_session_service.rb

@@ -0,0 +1,106 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class VerificationSessionService < StripeService
+      # A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
+      #
+      # Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
+      def cancel(session, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/identity/verification_sessions/%<session>s/cancel", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a VerificationSession object.
+      #
+      # After the VerificationSession is created, display a verification modal using the session client_secret or send your users to the session's url.
+      #
+      # If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
+      #
+      # Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents)
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/identity/verification_sessions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of VerificationSessions
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/identity/verification_sessions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Redact a VerificationSession to remove all collected information from Stripe. This will redact
+      # the VerificationSession and all objects related to it, including VerificationReports, Events,
+      # request logs, etc.
+      #
+      # A VerificationSession object can be redacted when it is in requires_input or verified
+      # [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
+      # state will automatically cancel it.
+      #
+      # The redaction process may take up to four days. When the redaction process is in progress, the
+      # VerificationSession's redaction.status field will be set to processing; when the process is
+      # finished, it will change to redacted and an identity.verification_session.redacted event
+      # will be emitted.
+      #
+      # Redaction is irreversible. Redacted objects are still accessible in the Stripe API, but all the
+      # fields that contain personal data will be replaced by the string [redacted] or a similar
+      # placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
+      # used for any purpose.
+      #
+      # [Learn more](https://stripe.com/docs/identity/verification-sessions#redact).
+      def redact(session, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/identity/verification_sessions/%<session>s/redact", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a VerificationSession that was previously created.
+      #
+      # When the session status is requires_input, you can use this method to retrieve a valid
+      # client_secret or url to allow re-submission.
+      def retrieve(session, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/identity/verification_sessions/%<session>s", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates a VerificationSession object.
+      #
+      # When the session status is requires_input, you can use this method to update the
+      # verification check and options.
+      def update(session, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/identity/verification_sessions/%<session>s", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/identity_service.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class IdentityService < StripeService
+    attr_reader :verification_reports, :verification_sessions
+
+    def initialize(requestor)
+      super(requestor)
+      @verification_reports = Stripe::Identity::VerificationReportService.new(@requestor)
+      @verification_sessions = Stripe::Identity::VerificationSessionService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/invoice_item_service.rb

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class InvoiceItemService < StripeService
+    # Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/invoiceitems",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they're not attached to invoices, or if it's attached to a draft invoice.
+    def delete(invoiceitem, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/invoiceitems/%<invoiceitem>s", { invoiceitem: CGI.escape(invoiceitem) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/invoiceitems",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the invoice item with the given ID.
+    def retrieve(invoiceitem, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/invoiceitems/%<invoiceitem>s", { invoiceitem: CGI.escape(invoiceitem) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it's attached to is closed.
+    def update(invoiceitem, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/invoiceitems/%<invoiceitem>s", { invoiceitem: CGI.escape(invoiceitem) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/invoice_line_item_service.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class InvoiceLineItemService < StripeService
+    # When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
+    def list(invoice, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/invoices/%<invoice>s/lines", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an invoice's line item. Some fields, such as tax_amounts, only live on the invoice line item,
+    # so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
+    # item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
+    # Updating an invoice's line item is only possible before the invoice is finalized.
+    def update(invoice, line_item_id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/lines/%<line_item_id>s", { invoice: CGI.escape(invoice), line_item_id: CGI.escape(line_item_id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/invoice_payment_service.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class InvoicePaymentService < StripeService
+    # When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
+    def list(invoice, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/invoices/%<invoice>s/payments", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the invoice payment with the given ID.
+    def retrieve(invoice, invoice_payment, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/invoices/%<invoice>s/payments/%<invoice_payment>s", { invoice: CGI.escape(invoice), invoice_payment: CGI.escape(invoice_payment) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end