invoice.rb in stripe-10.8.0

- old
+ new

@@ -38,34 +38,13 @@
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
     extend Stripe::APIOperations::Search
     include Stripe::APIOperations::Save
-    extend Stripe::APIOperations::NestedResource
 
     OBJECT_NAME = "invoice"
 
-    nested_resource_class_methods :payment, operations: %i[retrieve list]
-
-    # Attaches a PaymentIntent to the invoice, adding it to the list of payments.
-    # When the PaymentIntent's status changes to succeeded, the payment is credited
-    # to the invoice, increasing its amount_paid. When the invoice is fully paid, the
-    # invoice's status becomes paid.
-    #
-    # If the PaymentIntent's status is already succeeded when it is attached, it is
-    # credited to the invoice immediately.
-    #
-    # Related guide: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create)
-    def attach_payment_intent(params = {}, opts = {})
-      request_stripe_object(
-        method: :post,
-        path: format("/v1/invoices/%<invoice>s/attach_payment_intent", { invoice: CGI.escape(self["id"]) }),
-        params: params,
-        opts: opts
-      )
-    end
-
     # 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(params = {}, opts = {})
       request_stripe_object(
         method: :post,
         path: format("/v1/invoices/%<invoice>s/finalize", { invoice: CGI.escape(self["id"]) }),
@@ -114,42 +93,10 @@
         params: params,
         opts: opts
       )
     end
 
-    # Attaches a PaymentIntent to the invoice, adding it to the list of payments.
-    # When the PaymentIntent's status changes to succeeded, the payment is credited
-    # to the invoice, increasing its amount_paid. When the invoice is fully paid, the
-    # invoice's status becomes paid.
-    #
-    # If the PaymentIntent's status is already succeeded when it is attached, it is
-    # credited to the invoice immediately.
-    #
-    # Related guide: [Create an invoice payment](https://stripe.com/docs/invoicing/payments/create)
-    def self.attach_payment_intent(invoice, params = {}, opts = {})
-      request_stripe_object(
-        method: :post,
-        path: format("/v1/invoices/%<invoice>s/attach_payment_intent", { invoice: CGI.escape(invoice) }),
-        params: params,
-        opts: opts
-      )
-    end
-
-    # At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
-    #
-    # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
-    #
-    # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.
-    def self.create_preview(params = {}, opts = {})
-      request_stripe_object(
-        method: :post,
-        path: "/v1/invoices/create_preview",
-        params: params,
-        opts: opts
-      )
-    end
-
     # 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 self.finalize_invoice(invoice, params = {}, opts = {})
       request_stripe_object(
         method: :post,
         path: format("/v1/invoices/%<invoice>s/finalize", { invoice: CGI.escape(invoice) }),
@@ -217,14 +164,59 @@
         params: params,
         opts: opts
       )
     end
 
+    # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers.
+    def self.create(params = {}, opts = {})
+      request_stripe_object(method: :post, path: "/v1/invoices", params: params, opts: opts)
+    end
+
+    # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice).
+    def self.delete(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/invoices/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice).
+    def delete(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/invoices/%<invoice>s", { invoice: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.
+    def self.list(filters = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/invoices", params: filters, opts: opts)
+    end
+
     def self.search(params = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/invoices/search", params: params, opts: opts)
     end
 
     def self.search_auto_paging_each(params = {}, opts = {}, &blk)
       search(params, opts).auto_paging_each(&blk)
+    end
+
+    # Draft invoices are fully editable. Once an invoice is [finalized](https://stripe.com/docs/billing/invoices/workflow#finalized),
+    # monetary values, as well as collection_method, become uneditable.
+    #
+    # If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,
+    # sending reminders for, or [automatically reconciling](https://stripe.com/docs/billing/invoices/reconciliation) invoices, pass
+    # auto_advance=false.
+    def self.update(id, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/invoices/%<id>s", { id: CGI.escape(id) }),
+        params: params,
+        opts: opts
+      )
     end
   end
 end