stripe 15.5.0 → 15.6.0.pre.alpha.2

data/lib/stripe/resources/mandate.rb

@@ -4,19 +4,37 @@
 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"
     end
 
     class CustomerAcceptance < Stripe::StripeObject
-      class Offline < Stripe::StripeObject; end
+      class Offline < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
 
       class Online < Stripe::StripeObject
         # The customer accepts the mandate from this IP address.
         attr_reader :ip_address
         # The customer accepts the mandate using the user agent of the browser.
         attr_reader :user_agent
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
       # The time that the customer accepts the mandate.
       attr_reader :accepted_at
@@ -26,9 +44,30 @@ module Stripe
       attr_reader :online
       # The mandate includes the type of customer acceptance information, such as: `online` or `offline`.
       attr_reader :type
+
+      def self.inner_class_types
+        @inner_class_types = { offline: Offline, online: Online }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
 
-    class MultiUse < Stripe::StripeObject; 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
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
 
     class PaymentMethodDetails < Stripe::StripeObject
       class AcssDebit < Stripe::StripeObject
@@ -40,13 +79,37 @@ module Stripe
         attr_reader :payment_schedule
         # Transaction type of the mandate.
         attr_reader :transaction_type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
 
-      class AmazonPay < Stripe::StripeObject; end
+      class AmazonPay < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
 
       class AuBecsDebit < Stripe::StripeObject
         # The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.
         attr_reader :url
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
 
       class BacsDebit < Stripe::StripeObject
@@ -58,36 +121,200 @@ module Stripe
         attr_reader :revocation_reason
         # The URL that will contain the mandate that the customer has signed.
         attr_reader :url
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Card < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Cashapp < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class KakaoPay < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Klarna < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class KrCard < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Link < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
 
-      class Card < Stripe::StripeObject; end
-      class Cashapp < Stripe::StripeObject; end
-      class KakaoPay < Stripe::StripeObject; end
-      class Klarna < Stripe::StripeObject; end
-      class KrCard < Stripe::StripeObject; end
-      class Link < Stripe::StripeObject; end
-      class NaverPay < Stripe::StripeObject; end
-      class NzBankAccount < Stripe::StripeObject; end
+      class NaverPay < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class NzBankAccount < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
 
       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 RevolutPay < Stripe::StripeObject; 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 = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class RevolutPay < Stripe::StripeObject
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
 
       class SepaDebit < Stripe::StripeObject
         # The unique reference of the mandate.
         attr_reader :reference
         # The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.
         attr_reader :url
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
 
       class UsBankAccount < Stripe::StripeObject
         # Mandate collection method
         attr_reader :collection_method
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
       end
       # Attribute for field acss_debit
       attr_reader :acss_debit
@@ -115,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
@@ -123,6 +354,33 @@ module Stripe
       attr_reader :type
       # Attribute for field us_bank_account
       attr_reader :us_bank_account
+
+      def self.inner_class_types
+        @inner_class_types = {
+          acss_debit: AcssDebit,
+          amazon_pay: AmazonPay,
+          au_becs_debit: AuBecsDebit,
+          bacs_debit: BacsDebit,
+          card: Card,
+          cashapp: Cashapp,
+          kakao_pay: KakaoPay,
+          klarna: Klarna,
+          kr_card: KrCard,
+          link: Link,
+          naver_pay: NaverPay,
+          nz_bank_account: NzBankAccount,
+          paypal: Paypal,
+          payto: Payto,
+          pix: Pix,
+          revolut_pay: RevolutPay,
+          sepa_debit: SepaDebit,
+          us_bank_account: UsBankAccount,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
     end
 
     class SingleUse < Stripe::StripeObject
@@ -130,6 +388,49 @@ module Stripe
       attr_reader :amount
       # The currency of the payment on a single use mandate.
       attr_reader :currency
+
+      def self.inner_class_types
+        @inner_class_types = {}
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class ListParams < Stripe::RequestParams
+      # 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
+      # The Stripe account ID that the mandates are intended for. Learn more about the [use case for connected accounts payments](https://stripe.com/docs/payments/connected-accounts).
+      attr_accessor :on_behalf_of
+      # Attribute for param field payment_method
+      attr_accessor :payment_method
+      # 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
+      # The status of the mandates to retrieve. Status indicates whether or not you can use it to initiate a payment, and can have a value of `active`, `pending`, or `inactive`.
+      attr_accessor :status
+
+      def initialize(
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        on_behalf_of: nil,
+        payment_method: nil,
+        starting_after: nil,
+        status: nil
+      )
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @on_behalf_of = on_behalf_of
+        @payment_method = payment_method
+        @starting_after = starting_after
+        @status = status
+      end
     end
     # Attribute for field customer_acceptance
     attr_reader :customer_acceptance
@@ -153,5 +454,23 @@ module Stripe
     attr_reader :status
     # 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,
+        multi_use: MultiUse,
+        payment_method_details: PaymentMethodDetails,
+        single_use: SingleUse,
+      }
+    end
+
+    def self.field_remappings
+      @field_remappings = {}
+    end
   end
 end

data/lib/stripe/resources/margin.rb

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