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

data/lib/stripe/services/customer_cash_balance_transaction_service.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerCashBalanceTransactionService < StripeService
+    # Returns a list of transactions that modified the customer's [cash balance](https://stripe.com/docs/payments/customer-balance).
+    def list(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/cash_balance_transactions", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://stripe.com/docs/payments/customer-balance).
+    def retrieve(customer, transaction, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/cash_balance_transactions/%<transaction>s", { customer: CGI.escape(customer), transaction: CGI.escape(transaction) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_funding_instructions_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerFundingInstructionsService < StripeService
+    # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
+    # funding instructions will be created. If funding instructions have already been created for a given customer, the same
+    # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
+    def create(customer, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_payment_method_service.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerPaymentMethodService < StripeService
+    # Returns a list of PaymentMethods for a given Customer
+    def list(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves a PaymentMethod object for a given Customer.
+    def retrieve(customer, payment_method, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(customer), payment_method: CGI.escape(payment_method) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_payment_source_service.rb

@@ -0,0 +1,76 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerPaymentSourceService < StripeService
+    # When you create a new credit card, you must specify a customer or recipient on which to create it.
+    #
+    # If the card's owner has no default card, then the new card will become the default.
+    # However, if the owner already has a default, then it will not change.
+    # To change the default, you should [update the customer](https://stripe.com/docs/api#update_customer) to have a new default_source.
+    def create(customer, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/sources", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Delete a specified source for a given customer.
+    def delete(customer, id, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/sources/%<id>s", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # List sources for a specified customer.
+    def list(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/sources", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieve a specified source for a given customer.
+    def retrieve(customer, id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/sources/%<id>s", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Update a specified source for a given customer.
+    def update(customer, id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/sources/%<id>s", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Verify a specified bank account for a given customer.
+    def verify(customer, id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/sources/%<id>s/verify", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_service.rb

@@ -0,0 +1,89 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerService < StripeService
+    attr_reader :cash_balance, :balance_transactions, :cash_balance_transactions, :payment_sources, :tax_ids, :payment_methods, :funding_instructions
+
+    def initialize(requestor)
+      super(requestor)
+      @cash_balance = Stripe::CustomerCashBalanceService.new(@requestor)
+      @balance_transactions = Stripe::CustomerBalanceTransactionService.new(@requestor)
+      @cash_balance_transactions = Stripe::CustomerCashBalanceTransactionService.new(@requestor)
+      @payment_sources = Stripe::CustomerPaymentSourceService.new(@requestor)
+      @tax_ids = Stripe::CustomerTaxIdService.new(@requestor)
+      @payment_methods = Stripe::CustomerPaymentMethodService.new(@requestor)
+      @funding_instructions = Stripe::CustomerFundingInstructionsService.new(@requestor)
+    end
+
+    # Creates a new customer object.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/customers", params: params, opts: opts, base_address: :api)
+    end
+
+    # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
+    def delete(customer, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Removes the currently applied discount on a customer.
+    def delete_discount(customer, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/discount", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/customers", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves a Customer object.
+    def retrieve(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Search for customers you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+    # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+    # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+    # to an hour behind during outages. Search functionality is not available to merchants in India.
+    def search(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/customers/search",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer's active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer's current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
+    #
+    # This request accepts mostly the same arguments as the customer creation call.
+    def update(customer, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_session_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerSessionService < StripeService
+    # Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/customer_sessions",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_tax_id_service.rb

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerTaxIdService < StripeService
+    # Creates a new tax_id object for a customer.
+    def create(customer, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/tax_ids", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Deletes an existing tax_id object.
+    def delete(customer, id, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/tax_ids/%<id>s", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of tax IDs for a customer.
+    def list(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/tax_ids", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the tax_id object with the given identifier.
+    def retrieve(customer, id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/tax_ids/%<id>s", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/dispute_service.rb

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class DisputeService < StripeService
+    # Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
+    #
+    # The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
+    def close(dispute, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/disputes/%<dispute>s/close", { dispute: CGI.escape(dispute) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of your disputes.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/disputes", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the dispute with the given ID.
+    def retrieve(dispute, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/disputes/%<dispute>s", { dispute: CGI.escape(dispute) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.
+    #
+    # Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://stripe.com/docs/disputes/categories).
+    def update(dispute, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/disputes/%<dispute>s", { dispute: CGI.escape(dispute) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/entitlements/active_entitlement_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Entitlements
+    class ActiveEntitlementService < StripeService
+      # Retrieve a list of active entitlements for a customer
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/entitlements/active_entitlements",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve an active entitlement
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/entitlements/active_entitlements/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/entitlements/feature_service.rb

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Entitlements
+    class FeatureService < StripeService
+      # Creates a feature
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/entitlements/features",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieve a list of features
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/entitlements/features",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a feature
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/entitlements/features/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Update a feature's metadata or permanently deactivate it.
+      def update(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/entitlements/features/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/entitlements_service.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class EntitlementsService < StripeService
+    attr_reader :active_entitlements, :features
+
+    def initialize(requestor)
+      super(requestor)
+      @active_entitlements = Stripe::Entitlements::ActiveEntitlementService.new(@requestor)
+      @features = Stripe::Entitlements::FeatureService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/ephemeral_key_service.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class EphemeralKeyService < StripeService
+    # Creates a short-lived API key for a given resource.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/ephemeral_keys",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Invalidates a short-lived API key for a given resource.
+    def delete(key, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/ephemeral_keys/%<key>s", { key: CGI.escape(key) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/event_service.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class EventService < StripeService
+    # List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/events", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/events/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/exchange_rate_service.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ExchangeRateService < StripeService
+    # Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/exchange_rates",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the exchange rates from the given currency to every supported currency.
+    def retrieve(rate_id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/exchange_rates/%<rate_id>s", { rate_id: CGI.escape(rate_id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/file_link_service.rb

@@ -0,0 +1,38 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FileLinkService < StripeService
+    # Creates a new file link object.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/file_links", params: params, opts: opts, base_address: :api)
+    end
+
+    # Returns a list of file links.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/file_links", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the file link with the given ID.
+    def retrieve(link, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/file_links/%<link>s", { link: CGI.escape(link) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an existing file link object. Expired links can no longer be updated.
+    def update(link, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/file_links/%<link>s", { link: CGI.escape(link) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/file_service.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class FileService < StripeService
+    # To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
+    #
+    # All of Stripe's officially supported Client libraries support sending multipart/form-data.
+    def create(params = {}, opts = {})
+      if params[:file] && !params[:file].is_a?(String) && !params[:file].respond_to?(:read)
+        raise ArgumentError, "file must respond to `#read`"
+      end
+
+      opts = { content_type: MultipartEncoder::MULTIPART_FORM_DATA }.merge(Util.normalize_opts(opts))
+
+      request(method: :post, path: "/v1/files", params: params, opts: opts, base_address: :files)
+    end
+
+    # Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/files", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://stripe.com/docs/file-upload#download-file-contents).
+    def retrieve(file, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/files/%<file>s", { file: CGI.escape(file) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountInferredBalanceService < StripeService
+      # Lists the recorded inferred balances for a Financial Connections Account.
+      def list(account, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s/inferred_balances", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module FinancialConnections
+    class AccountOwnerService < StripeService
+      # Lists all owners for a given Account
+      def list(account, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/financial_connections/accounts/%<account>s/owners", { account: CGI.escape(account) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end