stripe 15.5.0 → 15.6.0.pre.alpha.1

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

@@ -7,6 +7,8 @@ module Stripe
       class ListParams < Stripe::RequestParams
         # Only return credit grants for this customer.
         attr_accessor :customer
+        # Only return credit grants for this account.
+        attr_accessor :customer_account
         # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
         attr_accessor :ending_before
         # Specifies which fields in the response should be expanded.
@@ -18,12 +20,14 @@ module Stripe
 
         def initialize(
           customer: nil,
+          customer_account: nil,
           ending_before: nil,
           expand: nil,
           limit: nil,
           starting_after: nil
         )
           @customer = customer
+          @customer_account = customer_account
           @ending_before = ending_before
           @expand = expand
           @limit = limit
@@ -33,6 +37,18 @@ module Stripe
 
       class CreateParams < Stripe::RequestParams
         class Amount < Stripe::RequestParams
+          class CustomPricingUnit < Stripe::RequestParams
+            # The ID of the custom pricing unit.
+            attr_accessor :id
+            # A positive integer representing the amount of the credit grant.
+            attr_accessor :value
+
+            def initialize(id: nil, value: nil)
+              @id = id
+              @value = value
+            end
+          end
+
           class Monetary < Stripe::RequestParams
             # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `value` parameter.
             attr_accessor :currency
@@ -44,12 +60,15 @@ module Stripe
               @value = value
             end
           end
+          # The custom pricing unit amount.
+          attr_accessor :custom_pricing_unit
           # The monetary amount.
           attr_accessor :monetary
           # The type of this amount. We currently only support `monetary` billing credits.
           attr_accessor :type
 
-          def initialize(monetary: nil, type: nil)
+          def initialize(custom_pricing_unit: nil, monetary: nil, type: nil)
+            @custom_pricing_unit = custom_pricing_unit
             @monetary = monetary
             @type = type
           end
@@ -57,6 +76,15 @@ module Stripe
 
         class ApplicabilityConfig < Stripe::RequestParams
           class Scope < Stripe::RequestParams
+            class BillableItem < Stripe::RequestParams
+              # The billable item ID this credit grant should apply to.
+              attr_accessor :id
+
+              def initialize(id: nil)
+                @id = id
+              end
+            end
+
             class Price < Stripe::RequestParams
               # The price ID this credit grant should apply to.
               attr_accessor :id
@@ -65,12 +93,15 @@ module Stripe
                 @id = id
               end
             end
+            # A list of billable items that the credit grant can apply to. We currently only support metered billable items. Cannot be used in combination with `price_type` or `prices`.
+            attr_accessor :billable_items
             # The price type that credit grants can apply to. We currently only support the `metered` price type. Cannot be used in combination with `prices`.
             attr_accessor :price_type
             # A list of prices that the credit grant can apply to. We currently only support the `metered` prices. Cannot be used in combination with `price_type`.
             attr_accessor :prices
 
-            def initialize(price_type: nil, prices: nil)
+            def initialize(billable_items: nil, price_type: nil, prices: nil)
+              @billable_items = billable_items
               @price_type = price_type
               @prices = prices
             end
@@ -90,6 +121,8 @@ module Stripe
         attr_accessor :category
         # ID of the customer to receive the billing credits.
         attr_accessor :customer
+        # ID of the account to receive the billing credits.
+        attr_accessor :customer_account
         # The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
         attr_accessor :effective_at
         # Specifies which fields in the response should be expanded.
@@ -108,6 +141,7 @@ module Stripe
           applicability_config: nil,
           category: nil,
           customer: nil,
+          customer_account: nil,
           effective_at: nil,
           expand: nil,
           expires_at: nil,
@@ -119,6 +153,7 @@ module Stripe
           @applicability_config = applicability_config
           @category = category
           @customer = customer
+          @customer_account = customer_account
           @effective_at = effective_at
           @expand = expand
           @expires_at = expires_at

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

@@ -0,0 +1,76 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class MeterUsageService < StripeService
+      class RetrieveParams < Stripe::RequestParams
+        class Meter < Stripe::RequestParams
+          # Key-value pairs used to filter usage events by meter dimension values. If specified, usage will be filtered for matching usage events.
+          attr_accessor :dimension_filters
+          # List of meter dimension keys to group by. If specified, usage events will be grouped by the given meter dimension key's values.
+          attr_accessor :dimension_group_by_keys
+          # Meter id to query usage for.
+          attr_accessor :meter_id
+          # Key-value pairs used to filter usage events by high cardinality tenant dimension values. If specified, usage will be filtered for matching usage events.
+          attr_accessor :tenant_filters
+
+          def initialize(
+            dimension_filters: nil,
+            dimension_group_by_keys: nil,
+            meter_id: nil,
+            tenant_filters: nil
+          )
+            @dimension_filters = dimension_filters
+            @dimension_group_by_keys = dimension_group_by_keys
+            @meter_id = meter_id
+            @tenant_filters = tenant_filters
+          end
+        end
+        # The customer id to fetch meter usage data for.
+        attr_accessor :customer
+        # The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
+        attr_accessor :end_time
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # An array of meter parameters to specify which meters to include in the usage data. If not specified, usage across all meters for the customer is included.
+        attr_accessor :meters
+        # The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
+        attr_accessor :start_time
+        # The timezone to use for the start and end times. Defaults to UTC if not specified.
+        attr_accessor :timezone
+        # Specifies what granularity to use when aggregating meter usage events. If not specified, a single event would be returned for the specified time range.
+        attr_accessor :value_grouping_window
+
+        def initialize(
+          customer: nil,
+          end_time: nil,
+          expand: nil,
+          meters: nil,
+          start_time: nil,
+          timezone: nil,
+          value_grouping_window: nil
+        )
+          @customer = customer
+          @end_time = end_time
+          @expand = expand
+          @meters = meters
+          @start_time = start_time
+          @timezone = timezone
+          @value_grouping_window = value_grouping_window
+        end
+      end
+
+      # Returns aggregated meter usage data for a customer within a specified time interval. The data can be grouped by various dimensions and can include multiple meters if specified.
+      def retrieve(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/billing/analytics/meter_usage",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

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

@@ -147,6 +147,8 @@ module Stripe
         attr_accessor :configuration
         # The ID of an existing customer.
         attr_accessor :customer
+        # The ID of an existing account.
+        attr_accessor :customer_account
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
         # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
@@ -161,6 +163,7 @@ module Stripe
         def initialize(
           configuration: nil,
           customer: nil,
+          customer_account: nil,
           expand: nil,
           flow_data: nil,
           locale: nil,
@@ -169,6 +172,7 @@ module Stripe
         )
           @configuration = configuration
           @customer = customer
+          @customer_account = customer_account
           @expand = expand
           @flow_data = flow_data
           @locale = locale

data/lib/stripe/services/billing_service.rb

@@ -3,7 +3,7 @@
 
 module Stripe
   class BillingService < StripeService
-    attr_reader :alerts, :credit_balance_summary, :credit_balance_transactions, :credit_grants, :meters, :meter_events, :meter_event_adjustments
+    attr_reader :alerts, :credit_balance_summary, :credit_balance_transactions, :credit_grants, :meters, :meter_events, :meter_event_adjustments, :meter_usage
 
     def initialize(requestor)
       super
@@ -15,6 +15,7 @@ module Stripe
       @meters = Stripe::Billing::MeterService.new(@requestor)
       @meter_events = Stripe::Billing::MeterEventService.new(@requestor)
       @meter_event_adjustments = Stripe::Billing::MeterEventAdjustmentService.new(@requestor)
+      @meter_usage = Stripe::Billing::MeterUsageService.new(@requestor)
     end
   end
 end

data/lib/stripe/services/capital/financing_offer_service.rb

@@ -0,0 +1,112 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    class FinancingOfferService < StripeService
+      class ListParams < Stripe::RequestParams
+        class Created < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          attr_accessor :gt
+          # Minimum value to filter by (inclusive)
+          attr_accessor :gte
+          # Maximum value to filter by (exclusive)
+          attr_accessor :lt
+          # Maximum value to filter by (inclusive)
+          attr_accessor :lte
+
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+            @gt = gt
+            @gte = gte
+            @lt = lt
+            @lte = lte
+          end
+        end
+        # limit list to offers belonging to given connected account
+        attr_accessor :connected_account
+        # Only return offers that were created during the given date interval.
+        attr_accessor :created
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+        # limit list to offers with given status
+        attr_accessor :status
+
+        def initialize(
+          connected_account: nil,
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil,
+          status: nil
+        )
+          @connected_account = connected_account
+          @created = created
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+          @status = status
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class MarkDeliveredParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Retrieves the financing offers available for Connected accounts that belong to your platform.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/capital/financing_offers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def mark_delivered(financing_offer, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Get the details of the financing offer
+      def retrieve(financing_offer, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s", { financing_offer: CGI.escape(financing_offer) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/capital/financing_summary_service.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    class FinancingSummaryService < StripeService
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Retrieve the financing state for the account that was authenticated in the request.
+      def retrieve(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/capital/financing_summary",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/capital/financing_transaction_service.rb

@@ -0,0 +1,79 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    class FinancingTransactionService < StripeService
+      class ListParams < Stripe::RequestParams
+        # For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this charge.
+        attr_accessor :charge
+        # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Returns transactions that were created that apply to this financing offer ID.
+        attr_accessor :financing_offer
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        attr_accessor :limit
+        # Only returns transactions that are responsible for reversing this financing transaction ID.
+        attr_accessor :reversed_transaction
+        # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+        attr_accessor :starting_after
+        # For transactions of type `paydown` and reason `automatic_withholding` only, only returns transactions that were created as a result of this Treasury Transaction.
+        attr_accessor :treasury_transaction
+
+        def initialize(
+          charge: nil,
+          ending_before: nil,
+          expand: nil,
+          financing_offer: nil,
+          limit: nil,
+          reversed_transaction: nil,
+          starting_after: nil,
+          treasury_transaction: nil
+        )
+          @charge = charge
+          @ending_before = ending_before
+          @expand = expand
+          @financing_offer = financing_offer
+          @limit = limit
+          @reversed_transaction = reversed_transaction
+          @starting_after = starting_after
+          @treasury_transaction = treasury_transaction
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      # Returns a list of financing transactions. The transactions are returned in sorted order,
+      # with the most recent transactions appearing first.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/capital/financing_transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a financing transaction for a financing offer.
+      def retrieve(financing_transaction, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/capital/financing_transactions/%<financing_transaction>s", { financing_transaction: CGI.escape(financing_transaction) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/capital_service.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CapitalService < StripeService
+    attr_reader :financing_offers, :financing_summary, :financing_transactions
+
+    def initialize(requestor)
+      super
+      @financing_offers = Stripe::Capital::FinancingOfferService.new(@requestor)
+      @financing_summary = Stripe::Capital::FinancingSummaryService.new(@requestor)
+      @financing_transactions = Stripe::Capital::FinancingTransactionService.new(@requestor)
+    end
+  end
+end