stripe 16.0.0 → 16.1.0.pre.beta.1

data/lib/stripe/resources/mandate.rb

@@ -4,6 +4,8 @@
 module Stripe
   # A Mandate is a record of the permission that your customer gives you to debit their payment method.
   class Mandate < APIResource
+    extend Stripe::APIOperations::List
+
     OBJECT_NAME = "mandate"
     def self.object_name
       "mandate"
@@ -53,6 +55,11 @@ module Stripe
     end
 
     class MultiUse < Stripe::StripeObject
+      # The amount of the payment on a multi use mandate.
+      attr_reader :amount
+      # The currency of the payment on a multi use mandate.
+      attr_reader :currency
+
       def self.inner_class_types
         @inner_class_types = {}
       end
@@ -207,8 +214,61 @@ 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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      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
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Pix < Stripe::StripeObject
+        # Determines if the amount includes the IOF tax.
+        attr_reader :amount_includes_iof
+        # Type of amount.
+        attr_reader :amount_type
+        # Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
+        attr_reader :end_date
+        # Schedule at which the future payments will be charged.
+        attr_reader :payment_schedule
+        # Subscription name displayed to buyers in their bank app.
+        attr_reader :reference
+        # Start date of the mandate, in `YYYY-MM-DD`.
+        attr_reader :start_date
 
         def self.inner_class_types
           @inner_class_types = {}
@@ -282,6 +342,10 @@ module Stripe
       attr_reader :nz_bank_account
       # Attribute for field paypal
       attr_reader :paypal
+      # Attribute for field payto
+      attr_reader :payto
+      # Attribute for field pix
+      attr_reader :pix
       # Attribute for field revolut_pay
       attr_reader :revolut_pay
       # Attribute for field sepa_debit
@@ -306,6 +370,8 @@ module Stripe
           naver_pay: NaverPay,
           nz_bank_account: NzBankAccount,
           paypal: Paypal,
+          payto: Payto,
+          pix: Pix,
           revolut_pay: RevolutPay,
           sepa_debit: SepaDebit,
           us_bank_account: UsBankAccount,
@@ -354,6 +420,11 @@ module Stripe
     # The type of the mandate.
     attr_reader :type
 
+    # Retrieves a list of Mandates for a given PaymentMethod.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/mandates", params: params, opts: opts)
+    end
+
     def self.inner_class_types
       @inner_class_types = {
         customer_acceptance: CustomerAcceptance,

data/lib/stripe/resources/margin.rb

@@ -0,0 +1,64 @@
+# 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
+
+    # 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
+
+    def self.inner_class_types
+      @inner_class_types = {}
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
+  end
+end