maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/controllers/products_controller.rb

@@ -0,0 +1,224 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ProductsController
+  class ProductsController < BaseController
+    # Use this method to create a product within your Chargify site.
+    # + [Products
+    # Documentation](https://maxio-chargify.zendesk.com/hc/en-us/articles/540556
+    # 1405709)
+    # + [Changing a Subscription's
+    # Product](https://maxio-chargify.zendesk.com/hc/en-us/articles/540422533466
+    # 9-Product-Changes-Migrations)
+    # @param [Integer] product_family_id Required parameter: The Chargify id of
+    # the product family to which the product belongs
+    # @param [CreateOrUpdateProductRequest] body Optional parameter: Example:
+    # @return [ProductResponse] response from the API call
+    def create_product(product_family_id,
+                       body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/product_families/{product_family_id}/products.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(product_family_id, key: 'product_family_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProductResponse.method(:from_hash))
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorListResponseException))
+        .execute
+    end
+
+    # This endpoint allows you to read the current details of a product that
+    # you've created in Chargify.
+    # @param [Integer] product_id Required parameter: The Chargify id of the
+    # product
+    # @return [ProductResponse] response from the API call
+    def read_product(product_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/products/{product_id}.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(product_id, key: 'product_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProductResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Use this method to change aspects of an existing product.
+    # ### Input Attributes Update Notes
+    # + `update_return_params` The parameters we will append to your
+    # `update_return_url`. See Return URLs and Parameters
+    # ### Product Price Point
+    # Updating a product using this endpoint will create a new price point and
+    # set it as the default price point for this product. If you should like to
+    # update an existing product price point, that must be done separately.
+    # @param [Integer] product_id Required parameter: The Chargify id of the
+    # product
+    # @param [CreateOrUpdateProductRequest] body Optional parameter: Example:
+    # @return [ProductResponse] response from the API call
+    def update_product(product_id,
+                       body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/products/{product_id}.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(product_id, key: 'product_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProductResponse.method(:from_hash))
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorListResponseException))
+        .execute
+    end
+
+    # Sending a DELETE request to this endpoint will archive the product. All
+    # current subscribers will be unffected; their subscription/purchase will
+    # continue to be charged monthly.
+    # This will restrict the option to chose the product for purchase via the
+    # Billing Portal, as well as disable Public Signup Pages for the product.
+    # @param [Integer] product_id Required parameter: The Chargify id of the
+    # product
+    # @return [ProductResponse] response from the API call
+    def archive_product(product_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/products/{product_id}.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(product_id, key: 'product_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProductResponse.method(:from_hash))
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorListResponseException))
+        .execute
+    end
+
+    # This method allows to retrieve a Product object by its `api_handle`.
+    # @param [String] api_handle Required parameter: The handle of the product
+    # @return [ProductResponse] response from the API call
+    def read_product_by_handle(api_handle)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/products/handle/{api_handle}.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(api_handle, key: 'api_handle')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProductResponse.method(:from_hash)))
+        .execute
+    end
+
+    # This method allows to retrieve a list of Products belonging to a Site.
+    # @param [BasicDateField] date_field Optional parameter: The type of filter
+    # you would like to apply to your search. Use in query:
+    # `date_field=created_at`.
+    # @param [Date] end_date Optional parameter: The end date (format
+    # YYYY-MM-DD) with which to filter the date_field. Returns products with a
+    # timestamp up to and including 11:59:59PM in your site’s time zone on the
+    # date specified.
+    # @param [DateTime] end_datetime Optional parameter: The end date and time
+    # (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns
+    # products with a timestamp at or before exact time provided in query. You
+    # can specify timezone in query - otherwise your site''s time zone will be
+    # used. If provided, this parameter will be used instead of end_date.
+    # @param [Date] start_date Optional parameter: The start date (format
+    # YYYY-MM-DD) with which to filter the date_field. Returns products with a
+    # timestamp at or after midnight (12:00:00 AM) in your site’s time zone on
+    # the date specified.
+    # @param [DateTime] start_datetime Optional parameter: The start date and
+    # time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field.
+    # Returns products with a timestamp at or after exact time provided in
+    # query. You can specify timezone in query - otherwise your site''s time
+    # zone will be used. If provided, this parameter will be used instead of
+    # start_date.
+    # @param [Integer] page Optional parameter: Result records are organized in
+    # pages. By default, the first page of results is displayed. The page
+    # parameter specifies a page number of results to fetch. You can start
+    # navigating through the pages to consume the results. You do this by
+    # passing in a page parameter. Retrieve the next page by adding ?page=2 to
+    # the query string. If there are no results to return, then an empty result
+    # set will be returned. Use in query `page=1`.
+    # @param [Integer] per_page Optional parameter: This parameter indicates how
+    # many records to fetch in each request. Default value is 20. The maximum
+    # allowed values is 200; any per_page value over 200 will be changed to 200.
+    # Use in query `per_page=200`.
+    # @param [TrueClass | FalseClass] include_archived Optional parameter:
+    # Include archived products. Use in query: `include_archived=true`.
+    # @param [ListProductsInclude] include Optional parameter: Allows including
+    # additional data in the response. Use in query
+    # `include=prepaid_product_price_point`.
+    # @param [IncludeNotNull]
+    # filter_prepaid_product_price_point_product_price_point_id Optional
+    # parameter: Allows fetching products only if a prepaid product price point
+    # is present or not. To use this filter you also have to include the
+    # following param in the request `include=prepaid_product_price_point`. Use
+    # in query
+    # `filter[prepaid_product_price_point][product_price_point_id]=not_null`.
+    # @param [TrueClass | FalseClass] filter_use_site_exchange_rate Optional
+    # parameter: Allows fetching products with matching use_site_exchange_rate
+    # based on provided value (refers to default price point). Use in query
+    # `filter[use_site_exchange_rate]=true`.
+    # @return [Array[ProductResponse]] response from the API call
+    def list_products(options = {})
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/products.json',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(options['date_field'], key: 'date_field'))
+                   .query_param(new_parameter(options['end_date'], key: 'end_date'))
+                   .query_param(new_parameter(options['end_datetime'], key: 'end_datetime'))
+                   .query_param(new_parameter(options['start_date'], key: 'start_date'))
+                   .query_param(new_parameter(options['start_datetime'], key: 'start_datetime'))
+                   .query_param(new_parameter(options['page'], key: 'page'))
+                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
+                   .query_param(new_parameter(options['include_archived'], key: 'include_archived'))
+                   .query_param(new_parameter(options['include'], key: 'include'))
+                   .query_param(new_parameter(options['filter_prepaid_product_price_point_product_price_point_id'], key: 'filter[prepaid_product_price_point][product_price_point_id]'))
+                   .query_param(new_parameter(options['filter_use_site_exchange_rate'], key: 'filter[use_site_exchange_rate]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProductResponse.method(:from_hash))
+                   .is_response_array(true))
+        .execute
+    end
+  end
+end

data/lib/advanced_billing/controllers/proforma_invoices_controller.rb

@@ -0,0 +1,359 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ProformaInvoicesController
+  class ProformaInvoicesController < BaseController
+    # This endpoint will trigger the creation of a consolidated proforma invoice
+    # asynchronously. It will return a 201 with no message, or a 422 with any
+    # errors. To find and view the new consolidated proforma invoice, you may
+    # poll the subscription group listing for proforma invoices; only one
+    # consolidated proforma invoice may be created per group at a time.
+    # If the information becomes outdated, simply void the old consolidated
+    # proforma invoice and generate a new one.
+    # ## Restrictions
+    # Proforma invoices are only available on Relationship Invoicing sites. To
+    # create a proforma invoice, the subscription must not be prepaid, and must
+    # be in a live state.
+    # @param [String] uid Required parameter: The uid of the subscription
+    # group
+    # @return [void] response from the API call
+    def create_consolidated_proforma_invoice(uid)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscription_groups/{uid}/proforma_invoices.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(uid, key: 'uid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorListResponseException))
+        .execute
+    end
+
+    # Only proforma invoices with a `consolidation_level` of parent are
+    # returned.
+    # By default, proforma invoices returned on the index will only include
+    # totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`,
+    # `credits`, `payments`, `custom_fields`. To include breakdowns, pass the
+    # specific field as a key in the query with a value set to true.
+    # @param [String] uid Required parameter: The uid of the subscription
+    # group
+    # @return [ProformaInvoice] response from the API call
+    def list_subscription_group_proforma_invoices(uid)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/subscription_groups/{uid}/proforma_invoices.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(uid, key: 'uid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProformaInvoice.method(:from_hash))
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException))
+        .execute
+    end
+
+    # Use this endpoint to read the details of an existing proforma invoice.
+    # ## Restrictions
+    # Proforma invoices are only available on Relationship Invoicing sites.
+    # @param [Integer] proforma_invoice_uid Required parameter: The uid of the
+    # proforma invoice
+    # @return [ProformaInvoice] response from the API call
+    def read_proforma_invoice(proforma_invoice_uid)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/proforma_invoices/{proforma_invoice_uid}.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(proforma_invoice_uid, key: 'proforma_invoice_uid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProformaInvoice.method(:from_hash))
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException))
+        .execute
+    end
+
+    # This endpoint will create a proforma invoice and return it as a response.
+    # If the information becomes outdated, simply void the old proforma invoice
+    # and generate a new one.
+    # If you would like to preview the next billing amounts without generating a
+    # full proforma invoice, please use the renewal preview endpoint.
+    # ## Restrictions
+    # Proforma invoices are only available on Relationship Invoicing sites. To
+    # create a proforma invoice, the subscription must not be in a group, must
+    # not be prepaid, and must be in a live state.
+    # @param [Integer] subscription_id Required parameter: The Chargify id of
+    # the subscription
+    # @return [ProformaInvoice] response from the API call
+    def create_proforma_invoice(subscription_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscriptions/{subscription_id}/proforma_invoices.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProformaInvoice.method(:from_hash))
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorListResponseException))
+        .execute
+    end
+
+    # By default, proforma invoices returned on the index will only include
+    # totals, not detailed breakdowns for `line_items`, `discounts`, `taxes`,
+    # `credits`, `payments`, or `custom_fields`. To include breakdowns, pass the
+    # specific field as a key in the query with a value set to `true`.
+    # @param [Integer] subscription_id Required parameter: The Chargify id of
+    # the subscription
+    # @param [String] start_date Optional parameter: The beginning date range
+    # for the invoice's Due Date, in the YYYY-MM-DD format.
+    # @param [String] end_date Optional parameter: The ending date range for the
+    # invoice's Due Date, in the YYYY-MM-DD format.
+    # @param [InvoiceStatus] status Optional parameter: The current status of
+    # the invoice.  Allowed Values: draft, open, paid, pending, voided
+    # @param [Integer] page Optional parameter: Result records are organized in
+    # pages. By default, the first page of results is displayed. The page
+    # parameter specifies a page number of results to fetch. You can start
+    # navigating through the pages to consume the results. You do this by
+    # passing in a page parameter. Retrieve the next page by adding ?page=2 to
+    # the query string. If there are no results to return, then an empty result
+    # set will be returned. Use in query `page=1`.
+    # @param [Integer] per_page Optional parameter: This parameter indicates how
+    # many records to fetch in each request. Default value is 20. The maximum
+    # allowed values is 200; any per_page value over 200 will be changed to 200.
+    # Use in query `per_page=200`.
+    # @param [Direction] direction Optional parameter: The sort direction of the
+    # returned invoices.
+    # @param [TrueClass | FalseClass] line_items Optional parameter: Include
+    # line items data
+    # @param [TrueClass | FalseClass] discounts Optional parameter: Include
+    # discounts data
+    # @param [TrueClass | FalseClass] taxes Optional parameter: Include taxes
+    # data
+    # @param [TrueClass | FalseClass] credits Optional parameter: Include
+    # credits data
+    # @param [TrueClass | FalseClass] payments Optional parameter: Include
+    # payments data
+    # @param [TrueClass | FalseClass] custom_fields Optional parameter: Include
+    # custom fields data
+    # @return [Array[ProformaInvoice]] response from the API call
+    def list_proforma_invoices(options = {})
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/subscriptions/{subscription_id}/proforma_invoices.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(options['subscription_id'], key: 'subscription_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(options['start_date'], key: 'start_date'))
+                   .query_param(new_parameter(options['end_date'], key: 'end_date'))
+                   .query_param(new_parameter(options['status'], key: 'status'))
+                   .query_param(new_parameter(options['page'], key: 'page'))
+                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
+                   .query_param(new_parameter(options['direction'], key: 'direction'))
+                   .query_param(new_parameter(options['line_items'], key: 'line_items'))
+                   .query_param(new_parameter(options['discounts'], key: 'discounts'))
+                   .query_param(new_parameter(options['taxes'], key: 'taxes'))
+                   .query_param(new_parameter(options['credits'], key: 'credits'))
+                   .query_param(new_parameter(options['payments'], key: 'payments'))
+                   .query_param(new_parameter(options['custom_fields'], key: 'custom_fields'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProformaInvoice.method(:from_hash))
+                   .is_response_array(true))
+        .execute
+    end
+
+    # This endpoint will void a proforma invoice that has the status "draft".
+    # ## Restrictions
+    # Proforma invoices are only available on Relationship Invoicing sites.
+    # Only proforma invoices that have the appropriate status may be reopened.
+    # If the invoice identified by {uid} does not have the appropriate status,
+    # the response will have HTTP status code 422 and an error message.
+    # A reason for the void operation is required to be included in the request
+    # body. If one is not provided, the response will have HTTP status code 422
+    # and an error message.
+    # @param [String] proforma_invoice_uid Required parameter: The uid of the
+    # proforma invoice
+    # @param [VoidInvoiceRequest] body Optional parameter: Example:
+    # @return [ProformaInvoice] response from the API call
+    def void_proforma_invoice(proforma_invoice_uid,
+                              body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/proforma_invoices/{proforma_invoice_uid}/void.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(proforma_invoice_uid, key: 'proforma_invoice_uid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProformaInvoice.method(:from_hash))
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException)
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorListResponseException))
+        .execute
+    end
+
+    # Return a preview of the data that will be included on a given
+    # subscription's proforma invoice if one were to be generated. It will have
+    # similar line items and totals as a renewal preview, but the response will
+    # be presented in the format of a proforma invoice. Consequently it will
+    # include additional information such as the name and addresses that will
+    # appear on the proforma invoice.
+    # The preview endpoint is subject to all the same conditions as the proforma
+    # invoice endpoint. For example, previews are only available on the
+    # Relationship Invoicing architecture, and previews cannot be made for
+    # end-of-life subscriptions.
+    # If all the data returned in the preview is as expected, you may then
+    # create a static proforma invoice and send it to your customer. The data
+    # within a preview will not be saved and will not be accessible after the
+    # call is made.
+    # Alternatively, if you have some proforma invoices already, you may make a
+    # preview call to determine whether any billing information for the
+    # subscription's upcoming renewal has changed.
+    # @param [Integer] subscription_id Required parameter: The Chargify id of
+    # the subscription
+    # @return [ProformaInvoicePreview] response from the API call
+    def preview_proforma_invoice(subscription_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscriptions/{subscription_id}/proforma_invoices/preview.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProformaInvoicePreview.method(:from_hash))
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException)
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorListResponseException))
+        .execute
+    end
+
+    # This endpoint is only available for Relationship Invoicing sites. It
+    # cannot be used to create consolidated proforma invoices or preview prepaid
+    # subscriptions.
+    # Create a proforma invoice to preview costs before a subscription's signup.
+    # Like other proforma invoices, it can be emailed to the customer, voided,
+    # and publicly viewed on the chargifypay domain.
+    # Pass a payload that resembles a subscription create or signup preview
+    # request. For example, you can specify components, coupons/a referral,
+    # offers, custom pricing, and an existing customer or payment profile to
+    # populate a shipping or billing address.
+    # A product and customer first name, last name, and email are the minimum
+    # requirements. We recommend associating the proforma invoice with a
+    # customer_id to easily find their proforma invoices, since the
+    # subscription_id will always be blank.
+    # @param [CreateSubscriptionRequest] body Optional parameter: Example:
+    # @return [ProformaInvoice] response from the API call
+    def create_signup_proforma_invoice(body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscriptions/proforma_invoices.json',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ProformaInvoice.method(:from_hash))
+                   .local_error_template('400',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ProformaBadRequestErrorResponseException)
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorArrayMapResponseException))
+        .execute
+    end
+
+    # This endpoint is only available for Relationship Invoicing sites. It
+    # cannot be used to create consolidated proforma invoice previews or preview
+    # prepaid subscriptions.
+    # Create a signup preview in the format of a proforma invoice to preview
+    # costs before a subscription's signup. You have the option of optionally
+    # previewing the first renewal's costs as well. The proforma invoice preview
+    # will not be persisted.
+    # Pass a payload that resembles a subscription create or signup preview
+    # request. For example, you can specify components, coupons/a referral,
+    # offers, custom pricing, and an existing customer or payment profile to
+    # populate a shipping or billing address.
+    # A product and customer first name, last name, and email are the minimum
+    # requirements.
+    # @param [String] include_next_proforma_invoice Optional parameter: Choose
+    # to include a proforma invoice preview for the first renewal
+    # @param [CreateSubscriptionRequest] body Optional parameter: Example:
+    # @return [SignupProformaPreviewResponse] response from the API call
+    def preview_signup_proforma_invoice(include_next_proforma_invoice: nil,
+                                        body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscriptions/proforma_invoices/preview.json',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .query_param(new_parameter(include_next_proforma_invoice, key: 'include=next_proforma_invoice'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(SignupProformaPreviewResponse.method(:from_hash))
+                   .local_error_template('400',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ProformaBadRequestErrorResponseException)
+                   .local_error_template('422',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         ErrorArrayMapResponseException))
+        .execute
+    end
+  end
+end