stripe 12.7.0.pre.beta.1 → 13.0.0

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

data/lib/stripe/services/customer_cash_balance_transaction_service.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerCashBalanceTransactionService < StripeService
+    # Returns a list of transactions that modified the customer's [cash balance](https://stripe.com/docs/payments/customer-balance).
+    def list(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/cash_balance_transactions", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves a specific cash balance transaction, which updated the customer's [cash balance](https://stripe.com/docs/payments/customer-balance).
+    def retrieve(customer, transaction, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/cash_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_funding_instructions_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerFundingInstructionsService < StripeService
+    # Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new
+    # funding instructions will be created. If funding instructions have already been created for a given customer, the same
+    # funding instructions will be retrieved. In other words, we will return the same funding instructions each time.
+    def create(customer, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/funding_instructions", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_payment_method_service.rb

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerPaymentMethodService < StripeService
+    # Returns a list of PaymentMethods for a given Customer
+    def list(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves a PaymentMethod object for a given Customer.
+    def retrieve(customer, payment_method, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/payment_methods/%<payment_method>s", { customer: CGI.escape(customer), payment_method: CGI.escape(payment_method) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_payment_source_service.rb

@@ -0,0 +1,76 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerPaymentSourceService < StripeService
+    # When you create a new credit card, you must specify a customer or recipient on which to create it.
+    #
+    # If the card's owner has no default card, then the new card will become the default.
+    # However, if the owner already has a default, then it will not change.
+    # To change the default, you should [update the customer](https://stripe.com/docs/api#update_customer) to have a new default_source.
+    def create(customer, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/sources", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Delete a specified source for a given customer.
+    def delete(customer, id, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/sources/%<id>s", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # List sources for a specified customer.
+    def list(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/sources", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieve a specified source for a given customer.
+    def retrieve(customer, id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/sources/%<id>s", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Update a specified source for a given customer.
+    def update(customer, id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/sources/%<id>s", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Verify a specified bank account for a given customer.
+    def verify(customer, id, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/sources/%<id>s/verify", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_service.rb

@@ -0,0 +1,89 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerService < StripeService
+    attr_reader :cash_balance, :balance_transactions, :cash_balance_transactions, :payment_sources, :tax_ids, :payment_methods, :funding_instructions
+
+    def initialize(requestor)
+      super(requestor)
+      @cash_balance = Stripe::CustomerCashBalanceService.new(@requestor)
+      @balance_transactions = Stripe::CustomerBalanceTransactionService.new(@requestor)
+      @cash_balance_transactions = Stripe::CustomerCashBalanceTransactionService.new(@requestor)
+      @payment_sources = Stripe::CustomerPaymentSourceService.new(@requestor)
+      @tax_ids = Stripe::CustomerTaxIdService.new(@requestor)
+      @payment_methods = Stripe::CustomerPaymentMethodService.new(@requestor)
+      @funding_instructions = Stripe::CustomerFundingInstructionsService.new(@requestor)
+    end
+
+    # Creates a new customer object.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/customers", params: params, opts: opts, base_address: :api)
+    end
+
+    # Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
+    def delete(customer, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Removes the currently applied discount on a customer.
+    def delete_discount(customer, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/discount", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/customers", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves a Customer object.
+    def retrieve(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Search for customers 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/customers/search",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer's active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer's current subscriptions, if the subscription bills automatically and is in the past_due state, then the latest open invoice for the subscription with automatic collection enabled will be retried. This retry will not count as an automatic retry, and will not affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer will not trigger this behavior.
+    #
+    # This request accepts mostly the same arguments as the customer creation call.
+    def update(customer, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_session_service.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerSessionService < StripeService
+    # Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.
+    def create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/customer_sessions",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/customer_tax_id_service.rb

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CustomerTaxIdService < StripeService
+    # Creates a new tax_id object for a customer.
+    def create(customer, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/customers/%<customer>s/tax_ids", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Deletes an existing tax_id object.
+    def delete(customer, id, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/customers/%<customer>s/tax_ids/%<id>s", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of tax IDs for a customer.
+    def list(customer, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/tax_ids", { customer: CGI.escape(customer) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the tax_id object with the given identifier.
+    def retrieve(customer, id, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/customers/%<customer>s/tax_ids/%<id>s", { customer: CGI.escape(customer), id: CGI.escape(id) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/dispute_service.rb

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class DisputeService < StripeService
+    # Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.
+    #
+    # The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.
+    def close(dispute, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/disputes/%<dispute>s/close", { dispute: CGI.escape(dispute) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of your disputes.
+    def list(params = {}, opts = {})
+      request(method: :get, path: "/v1/disputes", params: params, opts: opts, base_address: :api)
+    end
+
+    # Retrieves the dispute with the given ID.
+    def retrieve(dispute, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/disputes/%<dispute>s", { dispute: CGI.escape(dispute) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.
+    #
+    # Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://stripe.com/docs/disputes/categories).
+    def update(dispute, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/disputes/%<dispute>s", { dispute: CGI.escape(dispute) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end