stripe 12.7.0.pre.beta.1 → 13.0.0

data/lib/stripe/services/account_capability_service.rb

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class AccountCapabilityService < StripeService
+    # Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.
+    def list(account, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/capabilities", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves information about the specified Account Capability.
+    def retrieve(account, capability, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/capabilities/%<capability>s", { account: CGI.escape(account), capability: CGI.escape(capability) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
+    def update(account, capability, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/accounts/%<account>s/capabilities/%<capability>s", { account: CGI.escape(account), capability: CGI.escape(capability) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/account_external_account_service.rb

@@ -0,0 +1,68 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class AccountExternalAccountService < StripeService
+    # Create an external account for a given account.
+    def create(account, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/accounts/%<account>s/external_accounts", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Delete a specified external account for a given account.
+    def delete(account, id, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/accounts/%<account>s/external_accounts/%<id>s", { account: CGI.escape(account), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # List external accounts for an account.
+    def list(account, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/external_accounts", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieve a specified external account for a given account.
+    def retrieve(account, id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/external_accounts/%<id>s", { account: CGI.escape(account), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the metadata, account holder name, account holder type of a bank account belonging to
+    # a connected account and optionally sets it as the default for its currency. Other bank account
+    # details are not editable by design.
+    #
+    # You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection).
+    #
+    # You can re-enable a disabled bank account by performing an update call without providing any
+    # arguments or changes.
+    def update(account, id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/accounts/%<account>s/external_accounts/%<id>s", { account: CGI.escape(account), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/account_link_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class AccountLinkService < StripeService
+    # Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/account_links",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/account_login_link_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class AccountLoginLinkService < StripeService
+    # Creates a single-use login link for a connected account to access the Express Dashboard.
+    #
+    # You can only create login links for accounts that use the [Express Dashboard](https://stripe.com/connect/express-dashboard) and are connected to your platform.
+    def create(account, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/accounts/%<account>s/login_links", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/account_person_service.rb

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class AccountPersonService < StripeService
+    # Creates a new person.
+    def create(account, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
+    def delete(account, person, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/accounts/%<account>s/persons/%<person>s", { account: CGI.escape(account), person: CGI.escape(person) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
+    def list(account, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves an existing person.
+    def retrieve(account, person, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/persons/%<person>s", { account: CGI.escape(account), person: CGI.escape(person) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an existing person.
+    def update(account, person, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/accounts/%<account>s/persons/%<person>s", { account: CGI.escape(account), person: CGI.escape(person) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/account_service.rb

@@ -0,0 +1,100 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class AccountService < StripeService
+    attr_reader :capabilities, :external_accounts, :login_links, :persons
+
+    def initialize(requestor)
+      super(requestor)
+      @capabilities = Stripe::AccountCapabilityService.new(@requestor)
+      @external_accounts = Stripe::AccountExternalAccountService.new(@requestor)
+      @login_links = Stripe::AccountLoginLinkService.new(@requestor)
+      @persons = Stripe::AccountPersonService.new(@requestor)
+    end
+
+    # With [Connect](https://stripe.com/docs/connect), you can create Stripe accounts for your users.
+    # To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings).
+    #
+    # If you've already collected information for your connected accounts, you [can prefill that information](https://stripe.com/docs/connect/best-practices#onboarding) when
+    # creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding.
+    # You can prefill any information on the account.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/accounts", params: params, opts: opts, base_address: :api)
+    end
+
+    # With [Connect](https://stripe.com/connect), you can delete accounts you manage.
+    #
+    # Test-mode accounts can be deleted at any time.
+    #
+    # Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](https://stripe.com/api/balance/balance_object) are zero.
+    #
+    # If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
+    def delete(account, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/accounts/%<account>s", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of accounts connected to your platform via [Connect](https://stripe.com/docs/connect). If you're not a platform, the list is empty.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/accounts", params: params, opts: opts, base_address: :api)
+    end
+
+    # With [Connect](https://stripe.com/connect), you can reject accounts that you have flagged as suspicious.
+    #
+    # Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
+    def reject(account, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/accounts/%<account>s/reject", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the details of an account.
+    def retrieve(account, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/accounts/%<account>s", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the details of an account.
+    def retrieve_current(params = {}, opts = {})
+      request(method: :get, path: "/v1/account", params: params, opts: opts, base_address: :api)
+    end
+
+    # Updates a [connected account](https://stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are
+    # left unchanged.
+    #
+    # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection)
+    # is application, which includes Custom accounts, you can update any information on the account.
+    #
+    # For accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection)
+    # is stripe, which includes Standard and Express accounts, you can update all information until you create
+    # an [Account Link or <a href="/api/account_sessions">Account Session](https://stripe.com/api/account_links) to start Connect onboarding,
+    # after which some properties can no longer be updated.
+    #
+    # To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our
+    # [Connect](https://stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
+    def update(account, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/accounts/%<account>s", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/account_session_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class AccountSessionService < StripeService
+    # Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/account_sessions",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/apple_pay_domain_service.rb

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ApplePayDomainService < StripeService
+    # Create an apple pay domain.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/apple_pay/domains",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Delete an apple pay domain.
+    def delete(domain, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/apple_pay/domains/%<domain>s", { domain: CGI.escape(domain) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # List apple pay domains.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/apple_pay/domains",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieve an apple pay domain.
+    def retrieve(domain, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/apple_pay/domains/%<domain>s", { domain: CGI.escape(domain) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/application_fee_refund_service.rb

@@ -0,0 +1,60 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ApplicationFeeRefundService < StripeService
+    # Refunds an application fee that has previously been collected but not yet refunded.
+    # Funds will be refunded to the Stripe account from which the fee was originally collected.
+    #
+    # You can optionally refund only part of an application fee.
+    # You can do so multiple times, until the entire fee has been refunded.
+    #
+    # Once entirely refunded, an application fee can't be refunded again.
+    # This method will raise an error when called on an already-refunded application fee,
+    # or when trying to refund more money than is left on an application fee.
+    def create(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/application_fees/%<id>s/refunds", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.
+    def list(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/application_fees/%<id>s/refunds", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.
+    def retrieve(fee, id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/application_fees/%<fee>s/refunds/%<id>s", { fee: CGI.escape(fee), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    #
+    # This request only accepts metadata as an argument.
+    def update(fee, id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/application_fees/%<fee>s/refunds/%<id>s", { fee: CGI.escape(fee), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/application_fee_service.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ApplicationFeeService < StripeService
+    attr_reader :refunds
+
+    def initialize(requestor)
+      super(requestor)
+      @refunds = Stripe::ApplicationFeeRefundService.new(@requestor)
+    end
+
+    # Returns a list of application fees you've previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/application_fees",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/application_fees/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/apps/secret_service.rb

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Apps
+    class SecretService < StripeService
+      # Create or replace a secret in the secret store.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/apps/secrets",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Deletes a secret from the secret store by name and scope.
+      def delete_where(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/apps/secrets/delete",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Finds a secret in the secret store by name and scope.
+      def find(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/apps/secrets/find",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # List all secrets stored on the given scope.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/apps/secrets",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/apps_service.rb

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

data/lib/stripe/services/balance_service.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class BalanceService < StripeService
+    # Retrieves the current account balance, based on the authentication that was used to make the request.
+    #  For a sample request, see [Accounting for negative balances](https://stripe.com/docs/connect/account-balances#accounting-for-negative-balances).
+    def retrieve(params = {}, opts = {})
+      request(method: :get, path: "/v1/balance", params: params, opts: opts, base_address: :api)
+    end
+  end
+end

data/lib/stripe/services/balance_transaction_service.rb

@@ -0,0 +1,32 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class BalanceTransactionService < StripeService
+    # Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
+    #
+    # Note that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/balance_transactions",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the balance transaction with the given ID.
+    #
+    # Note that this endpoint previously used the path /v1/balance/history/:id.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/balance_transactions/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/billing/alert_service.rb

@@ -0,0 +1,74 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class AlertService < StripeService
+      # Reactivates this alert, allowing it to trigger again.
+      def activate(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/activate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Archives this alert, removing it from the list view and APIs. This is non-reversible.
+      def archive(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/archive", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a billing alert
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/billing/alerts",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Deactivates this alert, preventing it from triggering.
+      def deactivate(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/billing/alerts/%<id>s/deactivate", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Lists billing active and inactive alerts
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/alerts",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a billing alert given an ID
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/billing/alerts/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/billing/credit_balance_summary_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class CreditBalanceSummaryService < StripeService
+      # Retrieves the credit balance summary for a customer
+      def retrieve(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/credit_balance_summary",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end