stripe 19.3.0 → 19.4.0.pre.alpha.2

data/lib/stripe/services/gift_card_service.rb

@@ -0,0 +1,77 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class GiftCardService < StripeService
+    # Activates a third-party gift card and optionally sets its balance.
+    def activate(gift_card, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/gift_cards/%<gift_card>s/activate", { gift_card: CGI.escape(gift_card) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Cashout a third-party gift card by zeroing its balance.
+    def cashout(gift_card, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/gift_cards/%<gift_card>s/cashout", { gift_card: CGI.escape(gift_card) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Checks the balance of a third-party gift card.
+    def check_balance(gift_card, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/gift_cards/%<gift_card>s/check_balance", { gift_card: CGI.escape(gift_card) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Creates a gift card object.
+    def create(params = {}, opts = {})
+      request(method: :post, path: "/v1/gift_cards", params: params, opts: opts, base_address: :api)
+    end
+
+    # Reloads a third-party gift card by adding the specified amount to its balance.
+    def reload(gift_card, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/gift_cards/%<gift_card>s/reload", { gift_card: CGI.escape(gift_card) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves a third-party gift card object.
+    def retrieve(gift_card, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/gift_cards/%<gift_card>s", { gift_card: CGI.escape(gift_card) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Voids a previously performed gift card operation.
+    def void_operation(gift_card, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/gift_cards/%<gift_card>s/void_operation", { gift_card: CGI.escape(gift_card) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/identity/blocklist_entry_service.rb

@@ -0,0 +1,71 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Identity
+    class BlocklistEntryService < StripeService
+      # Creates a BlocklistEntry object from a verification report.
+      #
+      # A blocklist entry prevents future identity verifications that match the same identity information.
+      # You can create blocklist entries from verification reports that contain document extracted data
+      # or a selfie.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#add-a-blocklist-entry)
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/identity/blocklist_entries",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Disables a BlocklistEntry object.
+      #
+      # After a BlocklistEntry is disabled, it will no longer block future verifications that match
+      # the same information. This action is irreversible. To re-enable it, a new BlocklistEntry
+      # must be created using the same verification report.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#disable-a-blocklist-entry)
+      def disable(id, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/identity/blocklist_entries/%<id>s/disable", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Returns a list of BlocklistEntry objects associated with your account.
+      #
+      # The blocklist entries are returned sorted by creation date, with the most recently created
+      # entries appearing first.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#block-list)
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/identity/blocklist_entries",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a BlocklistEntry object by its identifier.
+      #
+      # Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#block-list)
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/identity/blocklist_entries/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/identity_service.rb

@@ -3,10 +3,11 @@
 
 module Stripe
   class IdentityService < StripeService
-    attr_reader :verification_reports, :verification_sessions
+    attr_reader :blocklist_entries, :verification_reports, :verification_sessions
 
     def initialize(requestor)
       super
+      @blocklist_entries = Stripe::Identity::BlocklistEntryService.new(@requestor)
       @verification_reports = Stripe::Identity::VerificationReportService.new(@requestor)
       @verification_sessions = Stripe::Identity::VerificationSessionService.new(@requestor)
     end

data/lib/stripe/services/invoice_item_service.rb

@@ -49,6 +49,50 @@ module Stripe
       )
     end
 
+    # Serializes an InvoiceItem create request into a batch job JSONL line.
+    def serialize_batch_create(params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an InvoiceItem delete request into a batch job JSONL line.
+    def serialize_batch_delete(invoiceitem, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoiceitem: invoiceitem }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an InvoiceItem update request into a batch job JSONL line.
+    def serialize_batch_update(invoiceitem, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoiceitem: invoiceitem }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
     # Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it's attached to is closed.
     def update(invoiceitem, params = {}, opts = {})
       params = ::Stripe::InvoiceItemUpdateParams.coerce_params(params) unless params.is_a?(Stripe::RequestParams)

data/lib/stripe/services/invoice_line_item_service.rb

@@ -14,6 +14,21 @@ module Stripe
       )
     end
 
+    # Serializes an InvoiceLineItem update request into a batch job JSONL line.
+    def serialize_batch_update(invoice, line_item_id, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoice: invoice, line_item_id: line_item_id }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
     # Updates an invoice's line item. Some fields, such as tax_amounts, only live on the invoice line item,
     # so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
     # item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.

data/lib/stripe/services/invoice_rendering_template_service.rb

@@ -36,6 +36,36 @@ module Stripe
       )
     end
 
+    # Serializes an InvoiceRenderingTemplate archive request into a batch job JSONL line.
+    def serialize_batch_archive(template, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { template: template }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an InvoiceRenderingTemplate unarchive request into a batch job JSONL line.
+    def serialize_batch_unarchive(template, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { template: template }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
     # Unarchive an invoice rendering template so it can be used on new Stripe objects again.
     def unarchive(template, params = {}, opts = {})
       request(

data/lib/stripe/services/invoice_service.rb

@@ -80,6 +80,17 @@ module Stripe
       )
     end
 
+    # Detaches a payment from the invoice, removing it from the list of payments
+    def detach_payment(invoice, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/detach_payment", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
     # Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method.
     def finalize_invoice(invoice, params = {}, opts = {})
       request(
@@ -167,6 +178,184 @@ module Stripe
       )
     end
 
+    # Serializes an Invoice add_lines request into a batch job JSONL line.
+    def serialize_batch_add_lines(invoice, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoice: invoice }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an Invoice create request into a batch job JSONL line.
+    def serialize_batch_create(params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an Invoice create_preview request into a batch job JSONL line.
+    def serialize_batch_create_preview(params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an Invoice delete request into a batch job JSONL line.
+    def serialize_batch_delete(invoice, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoice: invoice }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an Invoice finalize_invoice request into a batch job JSONL line.
+    def serialize_batch_finalize_invoice(invoice, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoice: invoice }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an Invoice mark_uncollectible request into a batch job JSONL line.
+    def serialize_batch_mark_uncollectible(invoice, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoice: invoice }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an Invoice pay request into a batch job JSONL line.
+    def serialize_batch_pay(invoice, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoice: invoice }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an Invoice remove_lines request into a batch job JSONL line.
+    def serialize_batch_remove_lines(invoice, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoice: invoice }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an Invoice send_invoice request into a batch job JSONL line.
+    def serialize_batch_send_invoice(invoice, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoice: invoice }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an Invoice update request into a batch job JSONL line.
+    def serialize_batch_update(invoice, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoice: invoice }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an Invoice update_lines request into a batch job JSONL line.
+    def serialize_batch_update_lines(invoice, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoice: invoice }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
+    # Serializes an Invoice void_invoice request into a batch job JSONL line.
+    def serialize_batch_void_invoice(invoice, params = {}, opts = {})
+      request_id = SecureRandom.uuid
+      stripe_version = opts[:stripe_version] || Stripe.api_version
+
+      request_body = {
+        id: request_id,
+        params: params,
+        stripe_version: stripe_version,
+      }
+      request_body[:path_params] = { invoice: invoice }
+      request_body[:context] = opts[:stripe_context] if opts[:stripe_context]
+      JSON.generate(request_body)
+    end
+
     # Draft invoices are fully editable. Once an invoice is [finalized](https://docs.stripe.com/docs/billing/invoices/workflow#finalized),
     # monetary values, as well as collection_method, become uneditable.
     #

data/lib/stripe/services/issuing/credit_underwriting_record_service.rb

@@ -0,0 +1,85 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class CreditUnderwritingRecordService < StripeService
+      # Update a CreditUnderwritingRecord object to correct mistakes.
+      def correct(credit_underwriting_record, params = {}, opts = {})
+        request(
+          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,
+          base_address: :api
+        )
+      end
+
+      # Creates a CreditUnderwritingRecord object with information about a credit application submission.
+      def create_from_application(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/issuing/credit_underwriting_records/create_from_application",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
+      def create_from_proactive_review(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/issuing/credit_underwriting_records/create_from_proactive_review",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      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 list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/issuing/credit_underwriting_records",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object from a decision made on a credit application.
+      def report_decision(credit_underwriting_record, params = {}, opts = {})
+        request(
+          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,
+          base_address: :api
+        )
+      end
+
+      # Update a CreditUnderwritingRecord object to report that a credit offer has been accepted.
+      def report_offer_acceptance(credit_underwriting_record, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_offer_acceptance", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a CreditUnderwritingRecord object.
+      def retrieve(credit_underwriting_record, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/issuing/dispute_settlement_detail_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class DisputeSettlementDetailService < StripeService
+      # Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/issuing/dispute_settlement_details",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves an Issuing DisputeSettlementDetail object.
+      def retrieve(dispute_settlement_detail, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/issuing/dispute_settlement_details/%<dispute_settlement_detail>s", { dispute_settlement_detail: CGI.escape(dispute_settlement_detail) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/issuing/fraud_liability_debit_service.rb

@@ -0,0 +1,30 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class FraudLiabilityDebitService < StripeService
+      # Returns a list of Issuing FraudLiabilityDebit objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/issuing/fraud_liability_debits",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves an Issuing FraudLiabilityDebit object.
+      def retrieve(fraud_liability_debit, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/issuing/fraud_liability_debits/%<fraud_liability_debit>s", { fraud_liability_debit: CGI.escape(fraud_liability_debit) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/issuing/program_service.rb

@@ -0,0 +1,52 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Issuing
+    class ProgramService < StripeService
+      # Create a Program object.
+      def create(params = {}, opts = {})
+        request(
+          method: :post,
+          path: "/v1/issuing/programs",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # List all of the programs the given Issuing user has access to.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/issuing/programs",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the program specified by the given id.
+      def retrieve(program, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/issuing/programs/%<program>s", { program: CGI.escape(program) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Updates a Program object.
+      def update(program, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/issuing/programs/%<program>s", { program: CGI.escape(program) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end