stripe 12.7.0.pre.beta.2 → 13.1.0.pre.beta.2

data/lib/stripe/services/capital/financing_transaction_service.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    class FinancingTransactionService < StripeService
+      # Returns a list of financing transactions. The transactions are returned in sorted order,
+      # with the most recent transactions appearing first.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/capital/financing_transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a financing transaction for a financing offer.
+      def retrieve(financing_transaction, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/capital/financing_transactions/%<financing_transaction>s", { financing_transaction: CGI.escape(financing_transaction) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/capital_service.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CapitalService < StripeService
+    attr_reader :financing_offers, :financing_summary, :financing_transactions
+
+    def initialize(requestor)
+      super(requestor)
+      @financing_offers = Stripe::Capital::FinancingOfferService.new(@requestor)
+      @financing_summary = Stripe::Capital::FinancingSummaryService.new(@requestor)
+      @financing_transactions = Stripe::Capital::FinancingTransactionService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/charge_service.rb

@@ -0,0 +1,69 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ChargeService < StripeService
+    # Capture the payment of an existing, uncaptured charge that was created with the capture option set to false.
+    #
+    # Uncaptured payments expire a set number of days after they are created ([7 by default](https://stripe.com/docs/charges/placing-a-hold)), after which they are marked as refunded and capture attempts will fail.
+    #
+    # Don't use this method to capture a PaymentIntent-initiated charge. Use [Capture a PaymentIntent](https://stripe.com/docs/api/payment_intents/capture).
+    def capture(charge, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/charges/%<charge>s/capture", { charge: CGI.escape(charge) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # This method is no longer recommended—use the [Payment Intents API](https://stripe.com/docs/api/payment_intents)
+    # to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge
+    # object used to request payment.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/charges", params: params, opts: opts, base_address: :api)
+    end
+
+    # Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/charges", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.
+    def retrieve(charge, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/charges/%<charge>s", { charge: CGI.escape(charge) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Search for charges you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+    # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+    # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+    # to an hour behind during outages. Search functionality is not available to merchants in India.
+    def search(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/charges/search",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    def update(charge, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/charges/%<charge>s", { charge: CGI.escape(charge) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/checkout/session_line_item_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Checkout
+    class SessionLineItemService < StripeService
+      # When retrieving a Checkout Session, 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(session, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/checkout/sessions/%<session>s/line_items", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/checkout/session_service.rb

@@ -0,0 +1,72 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Checkout
+    class SessionService < StripeService
+      attr_reader :line_items
+
+      def initialize(requestor)
+        super(requestor)
+        @line_items = Stripe::Checkout::SessionLineItemService.new(@requestor)
+      end
+
+      # Creates a Session object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/checkout/sessions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # A Session can be expired when it is in one of these statuses: open
+      #
+      # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
+      def expire(session, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/checkout/sessions/%<session>s/expire", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of Checkout Sessions.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/checkout/sessions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a Session object.
+      def retrieve(session, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/checkout/sessions/%<session>s", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates a Session object.
+      def update(session, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/checkout/sessions/%<session>s", { session: CGI.escape(session) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/checkout_service.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CheckoutService < StripeService
+    attr_reader :sessions
+
+    def initialize(requestor)
+      super(requestor)
+      @sessions = Stripe::Checkout::SessionService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/climate/order_service.rb

@@ -0,0 +1,68 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Climate
+    class OrderService < StripeService
+      # Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
+      # reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
+      # might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
+      # provides 90 days advance notice and refunds the amount_total.
+      def cancel(order, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/climate/orders/%<order>s/cancel", { order: CGI.escape(order) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a Climate order object for a given Climate product. The order will be processed immediately
+      # after creation and payment will be deducted your Stripe balance.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/climate/orders",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Lists all Climate order objects. The orders are returned sorted by creation date, with the
+      # most recently created orders appearing first.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/climate/orders",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Climate order object with the given ID.
+      def retrieve(order, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/climate/orders/%<order>s", { order: CGI.escape(order) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates the specified order by setting the values of the parameters passed.
+      def update(order, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/climate/orders/%<order>s", { order: CGI.escape(order) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/climate/product_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Climate
+    class ProductService < StripeService
+      # Lists all available Climate product objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/climate/products",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of a Climate product with the given ID.
+      def retrieve(product, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/climate/products/%<product>s", { product: CGI.escape(product) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/climate/supplier_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Climate
+    class SupplierService < StripeService
+      # Lists all available Climate supplier objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/climate/suppliers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a Climate supplier object.
+      def retrieve(supplier, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/climate/suppliers/%<supplier>s", { supplier: CGI.escape(supplier) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/climate_service.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ClimateService < StripeService
+    attr_reader :orders, :products, :suppliers
+
+    def initialize(requestor)
+      super(requestor)
+      @orders = Stripe::Climate::OrderService.new(@requestor)
+      @products = Stripe::Climate::ProductService.new(@requestor)
+      @suppliers = Stripe::Climate::SupplierService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/confirmation_token_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class ConfirmationTokenService < StripeService
+    # Retrieves an existing ConfirmationToken object
+    def retrieve(confirmation_token, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/confirmation_tokens/%<confirmation_token>s", { confirmation_token: CGI.escape(confirmation_token) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/country_spec_service.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CountrySpecService < StripeService
+    # Lists all Country Spec objects available in the API.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/country_specs",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a Country Spec for a given Country code.
+    def retrieve(country, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/country_specs/%<country>s", { country: CGI.escape(country) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/coupon_service.rb

@@ -0,0 +1,51 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CouponService < StripeService
+    # You can create coupons easily via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly.
+    #
+    # A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an amount_off of 200 is applied to it and an invoice with a subtotal of 300 will have a final total of 100 if a coupon with an amount_off of 200 is applied to it.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/coupons", params: params, opts: opts, base_address: :api)
+    end
+
+    # You can delete coupons via the [coupon management](https://dashboard.stripe.com/coupons) page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.
+    def delete(coupon, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of your coupons.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/coupons", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the coupon with the given ID.
+    def retrieve(coupon, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.
+    def update(coupon, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/coupons/%<coupon>s", { coupon: CGI.escape(coupon) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/credit_note_line_item_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNoteLineItemService < StripeService
+    # When retrieving a credit note, you'll get a lines 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(credit_note, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/credit_notes/%<credit_note>s/lines", { credit_note: CGI.escape(credit_note) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/credit_note_preview_lines_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNotePreviewLinesService < StripeService
+    # When retrieving a credit note preview, you'll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/credit_notes/preview/lines",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/credit_note_service.rb

@@ -0,0 +1,93 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CreditNoteService < StripeService
+    attr_reader :line_items, :preview_lines
+
+    def initialize(requestor)
+      super(requestor)
+      @line_items = Stripe::CreditNoteLineItemService.new(@requestor)
+      @preview_lines = Stripe::CreditNotePreviewLinesService.new(@requestor)
+    end
+
+    # Issue a credit note to adjust the amount of a finalized invoice. For a status=open invoice, a credit note reduces
+    # its amount_due. For a status=paid invoice, a credit note does not affect its amount_due. Instead, it can result
+    # in any combination of the following:
+    #
+    #
+    # Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
+    # Customer balance credit: credit the customer's balance (using credit_amount) which will be automatically applied to their next invoice when it's finalized.
+    # Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
+    #
+    #
+    # For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
+    #
+    # You may issue multiple credit notes for an invoice. Each credit note will increment the invoice's pre_payment_credit_notes_amount
+    # or post_payment_credit_notes_amount depending on its status at the time of credit note creation.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/credit_notes",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of credit notes.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/credit_notes",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Get a preview of a credit note without creating it.
+    def preview(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/credit_notes/preview",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the credit note object with the given identifier.
+    def retrieve(id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/credit_notes/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an existing credit note.
+    def update(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/credit_notes/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Marks a credit note as void. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
+    def void_credit_note(id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/credit_notes/%<id>s/void", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_balance_transaction_service.rb

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerBalanceTransactionService < StripeService
+    # Creates an immutable transaction that updates the customer's credit [balance](https://stripe.com/docs/billing/customer/balance).
+    def create(customer, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/balance_transactions", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of transactions that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).
+    def list(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/balance_transactions", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves a specific customer balance transaction that updated the customer's [balances](https://stripe.com/docs/billing/customer/balance).
+    def retrieve(customer, transaction, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/balance_transactions/%<transaction>s", { customer: CGI.escape(customer), transaction: CGI.escape(transaction) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Most credit balance transaction fields are immutable, but you may update its description and metadata.
+    def update(customer, transaction, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/balance_transactions/%<transaction>s", { customer: CGI.escape(customer), transaction: CGI.escape(transaction) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_cash_balance_service.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerCashBalanceService < StripeService
+    # Retrieves a customer's cash balance.
+    def retrieve(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Changes the settings on a customer's cash balance.
+    def update(customer, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/cash_balance", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end