stripe 15.1.0 → 15.2.0.pre.beta.1

data/lib/stripe/resources/issuing/fraud_liability_debit.rb

@@ -0,0 +1,86 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # A fraud liability debit occurs when Stripe debits a platform's account for fraud losses on Issuing transactions.
+    class FraudLiabilityDebit < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "issuing.fraud_liability_debit"
+      def self.object_name
+        "issuing.fraud_liability_debit"
+      end
+
+      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
+        # Only return Issuing Fraud Liability Debits 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
+
+        def initialize(
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil
+        )
+          @created = created
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+      # Debited amount. This is equal to the disputed amount and is given in the card’s currency and in the smallest currency unit.
+      attr_reader :amount
+      # ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this debit.
+      attr_reader :balance_transaction
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # The currency of the debit. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_reader :currency
+      # The ID of the linked dispute.
+      attr_reader :dispute
+      # Unique identifier for the object.
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+
+      # Returns a list of Issuing FraudLiabilityDebit objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+      def self.list(params = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/issuing/fraud_liability_debits",
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/issuing/settlement.rb

@@ -0,0 +1,53 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object.
+    class Settlement < APIResource
+      OBJECT_NAME = "issuing.settlement"
+      def self.object_name
+        "issuing.settlement"
+      end
+
+      # The Bank Identification Number reflecting this settlement record.
+      attr_reader :bin
+      # The date that the transactions are cleared and posted to user's accounts.
+      attr_reader :clearing_date
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      attr_reader :currency
+      # Unique identifier for the object.
+      attr_reader :id
+      # The total interchange received as reimbursement for the transactions.
+      attr_reader :interchange_fees_amount
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      attr_reader :livemode
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+      attr_reader :metadata
+      # The total net amount required to settle with the network.
+      attr_reader :net_total_amount
+      # The card network for this settlement report. One of ["visa", "maestro"]
+      attr_reader :network
+      # The total amount of fees owed to the network.
+      attr_reader :network_fees_amount
+      # The Settlement Identification Number assigned by the network.
+      attr_reader :network_settlement_identifier
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The total amount of any additional fees assessed by the card network.
+      attr_reader :other_fees_amount
+      # The total number of additional fees assessed by the card network.
+      attr_reader :other_fees_count
+      # One of `international` or `uk_national_net`.
+      attr_reader :settlement_service
+      # The current processing status of this settlement.
+      attr_reader :status
+      # The total transaction amount reflected in this settlement.
+      attr_reader :transaction_amount
+      # The total number of transactions reflected in this settlement.
+      attr_reader :transaction_count
+    end
+  end
+end

data/lib/stripe/resources/issuing/transaction.rb

@@ -215,6 +215,8 @@ module Stripe
         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
+        # Only return transactions that are associated with the given settlement.
+        attr_accessor :settlement
         # 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
         # Only return transactions that have the given type. One of `capture` or `refund`.
@@ -227,6 +229,7 @@ module Stripe
           ending_before: nil,
           expand: nil,
           limit: nil,
+          settlement: nil,
           starting_after: nil,
           type: nil
         )
@@ -236,6 +239,7 @@ module Stripe
           @ending_before = ending_before
           @expand = expand
           @limit = limit
+          @settlement = settlement
           @starting_after = starting_after
           @type = type
         end
@@ -920,6 +924,8 @@ module Stripe
       attr_reader :object
       # Additional purchase information that is optionally provided by the merchant.
       attr_reader :purchase_details
+      # The ID of the [settlement](https://stripe.com/docs/api/issuing/settlements) to which this transaction belongs.
+      attr_reader :settlement
       # [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null.
       attr_reader :token
       # [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts

data/lib/stripe/resources/line_item.rb

@@ -9,6 +9,15 @@ module Stripe
       "item"
     end
 
+    class AdjustableQuantity < Stripe::StripeObject
+      # Attribute for field enabled
+      attr_reader :enabled
+      # Attribute for field maximum
+      attr_reader :maximum
+      # Attribute for field minimum
+      attr_reader :minimum
+    end
+
     class Discount < Stripe::StripeObject
       # The amount discounted.
       attr_reader :amount
@@ -19,6 +28,22 @@ module Stripe
       attr_reader :discount
     end
 
+    class Display < Stripe::StripeObject
+      # Attribute for field description
+      attr_reader :description
+      # Attribute for field images
+      attr_reader :images
+      # Attribute for field name
+      attr_reader :name
+    end
+
+    class TaxCalculationReference < Stripe::StripeObject
+      # The calculation identifier for tax calculation response.
+      attr_reader :calculation_id
+      # The calculation identifier for tax calculation response line item.
+      attr_reader :calculation_item_id
+    end
+
     class Tax < Stripe::StripeObject
       # Amount of tax applied for this rate.
       attr_reader :amount
@@ -31,6 +56,8 @@ module Stripe
       # The amount on which tax is calculated, in cents (or local equivalent).
       attr_reader :taxable_amount
     end
+    # Attribute for field adjustable_quantity
+    attr_reader :adjustable_quantity
     # Total discount amount applied. If no discounts were applied, defaults to 0.
     attr_reader :amount_discount
     # Total before any discounts or taxes are applied.
@@ -45,14 +72,24 @@ module Stripe
     attr_reader :description
     # The discounts applied to the line item.
     attr_reader :discounts
+    # Attribute for field display
+    attr_reader :display
     # Unique identifier for the object.
     attr_reader :id
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    attr_reader :metadata
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object
     # The price used to generate the line item.
     attr_reader :price
+    # The ID of the product for this line item.
+    #
+    # This will always be the same as `price.product`.
+    attr_reader :product
     # The quantity of products being purchased.
     attr_reader :quantity
+    # The tax calculation identifiers of the line item.
+    attr_reader :tax_calculation_reference
     # The taxes applied to the line item.
     attr_reader :taxes
   end

data/lib/stripe/resources/mandate.rb

@@ -71,8 +71,30 @@ module Stripe
       class Paypal < Stripe::StripeObject
         # The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer.
         attr_reader :billing_agreement_id
+        # Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
+        attr_reader :fingerprint
         # PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
         attr_reader :payer_id
+        # Owner's verified email. Values are verified or provided by PayPal directly
+        # (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+        attr_reader :verified_email
+      end
+
+      class Payto < Stripe::StripeObject
+        # Amount that will be collected. It is required when `amount_type` is `fixed`.
+        attr_reader :amount
+        # The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively.
+        attr_reader :amount_type
+        # Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
+        attr_reader :end_date
+        # The periodicity at which payments will be collected.
+        attr_reader :payment_schedule
+        # The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
+        attr_reader :payments_per_period
+        # The purpose for which payments are made. Defaults to retail.
+        attr_reader :purpose
+        # Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
+        attr_reader :start_date
       end
 
       class RevolutPay < Stripe::StripeObject; end
@@ -112,6 +134,8 @@ module Stripe
       attr_reader :nz_bank_account
       # Attribute for field paypal
       attr_reader :paypal
+      # Attribute for field payto
+      attr_reader :payto
       # Attribute for field revolut_pay
       attr_reader :revolut_pay
       # Attribute for field sepa_debit

data/lib/stripe/resources/margin.rb

@@ -0,0 +1,115 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A (partner) margin represents a specific discount distributed in partner reseller programs to business partners who
+  # resell products and services and earn a discount (margin) for doing so.
+  class Margin < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "margin"
+    def self.object_name
+      "margin"
+    end
+
+    class ListParams < Stripe::RequestParams
+      # Only return margins that are active or inactive. For example, pass `true` to only list active margins.
+      attr_accessor :active
+      # 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
+
+      def initialize(active: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @active = active
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+
+    class CreateParams < Stripe::RequestParams
+      # Whether the margin can be applied to invoices, invoice items, or invoice line items or not. Defaults to `true`.
+      attr_accessor :active
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+      # Name of the margin, which is displayed to customers, such as on invoices.
+      attr_accessor :name
+      # Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
+      attr_accessor :percent_off
+
+      def initialize(active: nil, expand: nil, metadata: nil, name: nil, percent_off: nil)
+        @active = active
+        @expand = expand
+        @metadata = metadata
+        @name = name
+        @percent_off = percent_off
+      end
+    end
+
+    class UpdateParams < Stripe::RequestParams
+      # Whether the margin can be applied to invoices, invoice items, or invoice line items or not.
+      attr_accessor :active
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+      # Name of the margin, which is displayed to customers, such as on invoices.
+      attr_accessor :name
+
+      def initialize(active: nil, expand: nil, metadata: nil, name: nil)
+        @active = active
+        @expand = expand
+        @metadata = metadata
+        @name = name
+      end
+    end
+    # Whether the margin can be applied to invoices, invoice items, or invoice line items. Defaults to `true`.
+    attr_reader :active
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # Unique identifier for the object.
+    attr_reader :id
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    attr_reader :livemode
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    attr_reader :metadata
+    # Name of the margin that's displayed on, for example, invoices.
+    attr_reader :name
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Percent that will be taken off the subtotal before tax (after all other discounts and promotions) of any invoice to which the margin is applied.
+    attr_reader :percent_off
+    # Time at which the object was last updated. Measured in seconds since the Unix epoch.
+    attr_reader :updated
+
+    # Create a margin object to be used with invoices, invoice items, and invoice line items for a customer to represent a partner discount. A margin has a percent_off which is the percent that will be taken off the subtotal after all items and other discounts and promotions) of any invoices for a customer. Calculation of prorations do not include any partner margins applied on the original invoice item.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/billing/margins", params: params, opts: opts)
+    end
+
+    # Retrieve a list of your margins.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/billing/margins", params: params, opts: opts)
+    end
+
+    # Update the specified margin object. Certain fields of the margin object are not editable.
+    def self.update(margin, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/billing/margins/%<margin>s", { margin: CGI.escape(margin) }),
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end