stripe 10.13.0 → 10.14.0.pre.beta.1

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

@@ -0,0 +1,93 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module GiftCards
+    # A gift card transaction represents a single transaction on a referenced gift card.
+    # A transaction is in one of three states, `confirmed`, `held` or `canceled`. A `confirmed`
+    # transaction is one that has added/deducted funds. A `held` transaction has created a
+    # temporary hold on funds, which can then be cancelled or confirmed. A `held` transaction
+    # can be confirmed into a `confirmed` transaction, or canceled into a `canceled` transaction.
+    # A `canceled` transaction has no effect on a gift card's balance.
+    class Transaction < APIResource
+      extend Stripe::APIOperations::Create
+      extend Stripe::APIOperations::List
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "gift_cards.transaction"
+      def self.object_name
+        "gift_cards.transaction"
+      end
+
+      # Cancel a gift card transaction
+      def cancel(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Cancel a gift card transaction
+      def self.cancel(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/cancel", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Confirm a gift card transaction
+      def confirm(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Confirm a gift card transaction
+      def self.confirm(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s/confirm", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Create a gift card transaction
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/gift_cards/transactions",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # List gift card transactions for a gift card
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/gift_cards/transactions",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Update a gift card transaction
+      def self.update(id, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/gift_cards/transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/invoice.rb

@@ -38,6 +38,7 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::NestedResource
     extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
@@ -46,11 +47,83 @@ module Stripe
       "invoice"
     end
 
+    nested_resource_class_methods :payment, operations: %i[retrieve list]
+
+    # Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
+    def add_lines(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/add_lines", { invoice: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Adds multiple line items to an invoice. This is only possible when an invoice is still a draft.
+    def self.add_lines(invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/add_lines", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Attaches a PaymentIntent to the invoice, adding it to the list of payments.
+    # When the PaymentIntent's status changes to succeeded, the payment is credited
+    # to the invoice, increasing its amount_paid. When the invoice is fully paid, the
+    # invoice's status becomes paid.
+    #
+    # If the PaymentIntent's status is already succeeded when it is attached, it is
+    # credited to the invoice immediately.
+    #
+    # Related guide: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create)
+    def attach_payment_intent(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/attach_payment_intent", { invoice: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Attaches a PaymentIntent to the invoice, adding it to the list of payments.
+    # When the PaymentIntent's status changes to succeeded, the payment is credited
+    # to the invoice, increasing its amount_paid. When the invoice is fully paid, the
+    # invoice's status becomes paid.
+    #
+    # If the PaymentIntent's status is already succeeded when it is attached, it is
+    # credited to the invoice immediately.
+    #
+    # Related guide: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create)
+    def self.attach_payment_intent(invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/attach_payment_intent", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/invoices", params: params, opts: opts)
     end
 
+    # At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
+    #
+    # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
+    #
+    # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.
+    def self.create_preview(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: "/v1/invoices/create_preview",
+        params: params,
+        opts: opts
+      )
+    end
+
     # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice).
     def self.delete(id, params = {}, opts = {})
       request_stripe_object(
@@ -146,6 +219,26 @@ module Stripe
       )
     end
 
+    # Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
+    def remove_lines(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/remove_lines", { invoice: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Removes multiple line items from an invoice. This is only possible when an invoice is still a draft.
+    def self.remove_lines(invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/remove_lines", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def self.search(params = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/invoices/search", params: params, opts: opts)
     end
@@ -202,6 +295,26 @@ module Stripe
       )
     end
 
+    # Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
+    def update_lines(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/update_lines", { invoice: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Updates multiple line items on an invoice. This is only possible when an invoice is still a draft.
+    def self.update_lines(invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/update_lines", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
     def void_invoice(params = {}, opts = {})
       request_stripe_object(

data/lib/stripe/resources/invoice_payment.rb

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # The invoice payment object
+  class InvoicePayment < APIResource
+    OBJECT_NAME = "invoice_payment"
+    def self.object_name
+      "invoice_payment"
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    # Every time an applicant submits an application for a Charge Card product your platform offers, or every time your platform takes a proactive credit decision on an existing account, you must record the decision by creating a new `CreditUnderwritingRecord` object on a connected account.
+    #
+    # [Follow the guide](https://stripe.com/docs/issuing/credit/report-credit-decisions-and-manage-aans) to learn about your requirements as a platform.
+    class CreditUnderwritingRecord < APIResource
+      extend Stripe::APIOperations::List
+
+      OBJECT_NAME = "issuing.credit_underwriting_record"
+      def self.object_name
+        "issuing.credit_underwriting_record"
+      end
+
+      # Update a CreditUnderwritingRecord object to correct mistakes.
+      def correct(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/correct", { credit_underwriting_record: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object to correct mistakes.
+      def self.correct(credit_underwriting_record, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/correct", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a CreditUnderwritingRecord object with information about a credit application submission.
+      def self.create_from_application(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/issuing/credit_underwriting_records/create_from_application",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
+      def self.create_from_proactive_review(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/issuing/credit_underwriting_records/create_from_proactive_review",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Retrieves a list of CreditUnderwritingRecord objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
+      def self.list(filters = {}, opts = {})
+        request_stripe_object(
+          method: :get,
+          path: "/v1/issuing/credit_underwriting_records",
+          params: filters,
+          opts: opts
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object from a decision made on a credit application.
+      def report_decision(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_decision", { credit_underwriting_record: CGI.escape(self["id"]) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object from a decision made on a credit application.
+      def self.report_decision(credit_underwriting_record, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_decision", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
+          params: params,
+          opts: opts
+        )
+      end
+    end
+  end
+end

data/lib/stripe/resources/margin.rb

@@ -0,0 +1,37 @@
+# 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
+
+    # 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(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/billing/margins", params: filters, opts: opts)
+    end
+
+    # Update the specified margin object. Certain fields of the margin object are not editable.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/billing/margins/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/order.rb

@@ -0,0 +1,120 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # An Order describes a purchase being made by a customer, including the
+  # products & quantities being purchased, the order status, the payment information,
+  # and the billing/shipping details.
+  #
+  # Related guide: [Orders overview](https://stripe.com/docs/orders)
+  class Order < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
+
+    OBJECT_NAME = "order"
+    def self.object_name
+      "order"
+    end
+
+    # Cancels the order as well as the payment intent if one is attached.
+    def cancel(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Cancels the order as well as the payment intent if one is attached.
+    def self.cancel(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/cancel", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Creates a new open order object.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/orders", params: params, opts: opts)
+    end
+
+    # Returns a list of your orders. The orders are returned sorted by creation date, with the most recently created orders appearing first.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/orders", params: filters, opts: opts)
+    end
+
+    # When retrieving an order, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
+    def list_line_items(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # When retrieving an order, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
+    def self.list_line_items(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/orders/%<id>s/line_items", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Reopens a submitted order.
+    def reopen(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Reopens a submitted order.
+    def self.reopen(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/reopen", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called.
+    def submit(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Submitting an Order transitions the status to processing and creates a PaymentIntent object so the order can be paid. If the Order has an amount_total of 0, no PaymentIntent object will be created. Once the order is submitted, its contents cannot be changed, unless the [reopen](https://stripe.com/docs/api#reopen_order) method is called.
+    def self.submit(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s/submit", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Updates the specific order by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/orders/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

data/lib/stripe/resources/payment_intent.rb

@@ -176,6 +176,56 @@ module Stripe
       request_stripe_object(method: :post, path: "/v1/payment_intents", params: params, opts: opts)
     end
 
+    # Perform an decremental authorization on an eligible
+    # [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the
+    # PaymentIntent's status must be requires_capture and
+    # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization)
+    # must be available.
+    #
+    # Decremental authorizations decrease the authorized amount on your customer's card
+    # to the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
+    #
+    # After decrement, the PaymentIntent object
+    # returns with the updated
+    # [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
+    # The PaymentIntent will now be capturable up to the new authorized amount.
+    #
+    # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.
+    # After it's captured, a PaymentIntent can no longer be decremented.
+    def decrement_authorization(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/decrement_authorization", { intent: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Perform an decremental authorization on an eligible
+    # [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the
+    # PaymentIntent's status must be requires_capture and
+    # [decremental_authorization.status](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card-decremental_authorization)
+    # must be available.
+    #
+    # Decremental authorizations decrease the authorized amount on your customer's card
+    # to the new, lower amount provided. A single PaymentIntent can call this endpoint multiple times to further decrease the authorized amount.
+    #
+    # After decrement, the PaymentIntent object
+    # returns with the updated
+    # [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount).
+    # The PaymentIntent will now be capturable up to the new authorized amount.
+    #
+    # Each PaymentIntent can have a maximum of 10 decremental or incremental authorization attempts, including declines.
+    # After it's captured, a PaymentIntent can no longer be decremented.
+    def self.decrement_authorization(intent, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/payment_intents/%<intent>s/decrement_authorization", { intent: CGI.escape(intent) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     # Perform an incremental authorization on an eligible
     # [PaymentIntent](https://stripe.com/docs/api/payment_intents/object). To be eligible, the
     # PaymentIntent's status must be requires_capture and

data/lib/stripe/resources/product.rb

@@ -14,6 +14,7 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::NestedResource
     extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
 
@@ -22,6 +23,8 @@ module Stripe
       "product"
     end
 
+    nested_resource_class_methods :feature, operations: %i[create delete list]
+
     # Creates a new product object.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/products", params: params, opts: opts)

data/lib/stripe/resources/product_feature.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A product_feature represents an attachment between a feature and a product.
+  # When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.
+  class ProductFeature < APIResource
+    OBJECT_NAME = "product_feature"
+    def self.object_name
+      "product_feature"
+    end
+  end
+end