stripe 12.5.0.pre.beta.1 → 12.5.0

data/lib/stripe/resources/financial_connections/institution.rb

@@ -1,26 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module FinancialConnections
-    # An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.
-    class Institution < APIResource
-      extend Stripe::APIOperations::List
-
-      OBJECT_NAME = "financial_connections.institution"
-      def self.object_name
-        "financial_connections.institution"
-      end
-
-      # Returns a list of Financial Connections Institution objects.
-      def self.list(filters = {}, opts = {})
-        request_stripe_object(
-          method: :get,
-          path: "/v1/financial_connections/institutions",
-          params: filters,
-          opts: opts
-        )
-      end
-    end
-  end
-end

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

@@ -1,59 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module GiftCards
-    # A gift card represents a single gift card owned by a customer, including the
-    # remaining balance, gift card code, and whether or not it is active.
-    class Card < APIResource
-      extend Stripe::APIOperations::Create
-      extend Stripe::APIOperations::List
-      include Stripe::APIOperations::Save
-
-      OBJECT_NAME = "gift_cards.card"
-      def self.object_name
-        "gift_cards.card"
-      end
-
-      # Creates a new gift card object.
-      def self.create(params = {}, opts = {})
-        request_stripe_object(
-          method: :post,
-          path: "/v1/gift_cards/cards",
-          params: params,
-          opts: opts
-        )
-      end
-
-      # List gift cards for an account
-      def self.list(filters = {}, opts = {})
-        request_stripe_object(
-          method: :get,
-          path: "/v1/gift_cards/cards",
-          params: filters,
-          opts: opts
-        )
-      end
-
-      # Update a gift card
-      def self.update(id, params = {}, opts = {})
-        request_stripe_object(
-          method: :post,
-          path: format("/v1/gift_cards/cards/%<id>s", { id: CGI.escape(id) }),
-          params: params,
-          opts: opts
-        )
-      end
-
-      # Validates a gift card code, returning the matching gift card object if it exists.
-      def self.validate(params = {}, opts = {})
-        request_stripe_object(
-          method: :post,
-          path: "/v1/gift_cards/cards/validate",
-          params: params,
-          opts: opts
-        )
-      end
-    end
-  end
-end

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

@@ -1,93 +0,0 @@
-# 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_payment.rb

@@ -1,12 +0,0 @@
-# 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

@@ -1,88 +0,0 @@
-# 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

@@ -1,37 +0,0 @@
-# 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

@@ -1,120 +0,0 @@
-# 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/quote_phase.rb

@@ -1,39 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  # A quote phase describes the line items, coupons, and trialing status of a subscription for a predefined time period.
-  class QuotePhase < APIResource
-    extend Stripe::APIOperations::List
-
-    OBJECT_NAME = "quote_phase"
-    def self.object_name
-      "quote_phase"
-    end
-
-    # Returns a list of quote phases.
-    def self.list(filters = {}, opts = {})
-      request_stripe_object(method: :get, path: "/v1/quote_phases", params: filters, opts: opts)
-    end
-
-    # When retrieving a quote phase, 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/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(self["id"]) }),
-        params: params,
-        opts: opts
-      )
-    end
-
-    # When retrieving a quote phase, 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(quote_phase, params = {}, opts = {})
-      request_stripe_object(
-        method: :get,
-        path: format("/v1/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(quote_phase) }),
-        params: params,
-        opts: opts
-      )
-    end
-  end
-end

data/lib/stripe/resources/quote_preview_invoice.rb

@@ -1,43 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  # Invoices are statements of amounts owed by a customer, and are either
-  # generated one-off, or generated periodically from a subscription.
-  #
-  # They contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments
-  # that may be caused by subscription upgrades/downgrades (if necessary).
-  #
-  # If your invoice is configured to be billed through automatic charges,
-  # Stripe automatically finalizes your invoice and attempts payment. Note
-  # that finalizing the invoice,
-  # [when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does
-  # not happen immediately as the invoice is created. Stripe waits
-  # until one hour after the last webhook was successfully sent (or the last
-  # webhook timed out after failing). If you (and the platforms you may have
-  # connected to) have no webhooks configured, Stripe waits one hour after
-  # creation to finalize the invoice.
-  #
-  # If your invoice is configured to be billed by sending an email, then based on your
-  # [email settings](https://dashboard.stripe.com/account/billing/automatic),
-  # Stripe will email the invoice to your customer and await payment. These
-  # emails can contain a link to a hosted page to pay the invoice.
-  #
-  # Stripe applies any customer credit on the account before determining the
-  # amount due for the invoice (i.e., the amount that will be actually
-  # charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge
-  # per currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
-  # invoice is automatically marked paid, and we add the amount due to the
-  # customer's credit balance which is applied to the next invoice.
-  #
-  # More details on the customer's credit balance are
-  # [here](https://stripe.com/docs/billing/customer/balance).
-  #
-  # Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)
-  class QuotePreviewInvoice < APIResource
-    OBJECT_NAME = "quote_preview_invoice"
-    def self.object_name
-      "quote_preview_invoice"
-    end
-  end
-end

data/lib/stripe/resources/quote_preview_subscription_schedule.rb

@@ -1,11 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  class QuotePreviewSubscriptionSchedule < APIResource
-    OBJECT_NAME = "quote_preview_subscription_schedule"
-    def self.object_name
-      "quote_preview_subscription_schedule"
-    end
-  end
-end

data/lib/stripe/resources/tax/association.rb

@@ -1,24 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Tax
-    # A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input
-    class Association < APIResource
-      OBJECT_NAME = "tax.association"
-      def self.object_name
-        "tax.association"
-      end
-
-      # Finds a tax association object by PaymentIntent id.
-      def self.find(params = {}, opts = {})
-        request_stripe_object(
-          method: :get,
-          path: "/v1/tax/associations/find",
-          params: params,
-          opts: opts
-        )
-      end
-    end
-  end
-end

data/lib/stripe/resources/tax/form.rb

@@ -1,49 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-module Stripe
-  module Tax
-    # Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.
-    #
-    # Related guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)
-    class Form < APIResource
-      extend Stripe::APIOperations::List
-
-      OBJECT_NAME = "tax.form"
-      def self.object_name
-        "tax.form"
-      end
-
-      # Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
-      def self.list(filters = {}, opts = {})
-        request_stripe_object(method: :get, path: "/v1/tax/forms", params: filters, opts: opts)
-      end
-
-      # Download the PDF for a tax form.
-      def pdf(params = {}, opts = {}, &read_body_chunk_block)
-        config = opts[:client]&.config || Stripe.config
-        opts = { api_base: config.uploads_base }.merge(opts)
-        request_stream(
-          method: :get,
-          path: format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(self["id"]) }),
-          params: params,
-          opts: opts,
-          &read_body_chunk_block
-        )
-      end
-
-      # Download the PDF for a tax form.
-      def self.pdf(id, params = {}, opts = {}, &read_body_chunk_block)
-        config = opts[:client]&.config || Stripe.config
-        opts = { api_base: config.uploads_base }.merge(opts)
-        execute_resource_request_stream(
-          :get,
-          format("/v1/tax/forms/%<id>s/pdf", { id: CGI.escape(id) }),
-          params,
-          opts,
-          &read_body_chunk_block
-        )
-      end
-    end
-  end
-end