maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/configuration.rb

@@ -0,0 +1,123 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: Production server
+    # ENVIRONMENT2: Production server
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze,
+      ENVIRONMENT2 = 'environment2'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :subdomain, :domain, :basic_auth_user_name, :basic_auth_password
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(connection: nil, adapter: :net_http_persistent, timeout: 30,
+                   max_retries: 0, retry_interval: 1, backoff_factor: 2,
+                   retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                   retry_methods: %i[get put], http_callback: nil,
+                   environment: Environment::PRODUCTION, subdomain: 'subdomain',
+                   domain: 'chargify.com',
+                   basic_auth_user_name: 'TODO: Replace',
+                   basic_auth_password: 'TODO: Replace')
+
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The subdomain for your Chargify site.
+      @subdomain = subdomain
+
+      # The Chargify server domain.
+      @domain = domain
+
+      # The username to use with basic authentication
+      @basic_auth_user_name = basic_auth_user_name
+
+      # The password to use with basic authentication
+      @basic_auth_password = basic_auth_password
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   environment: nil, subdomain: nil, domain: nil,
+                   basic_auth_user_name: nil, basic_auth_password: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      environment ||= self.environment
+      subdomain ||= self.subdomain
+      domain ||= self.domain
+      basic_auth_user_name ||= self.basic_auth_user_name
+      basic_auth_password ||= self.basic_auth_password
+
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods,
+                        http_callback: http_callback, environment: environment,
+                        subdomain: subdomain, domain: domain,
+                        basic_auth_user_name: basic_auth_user_name,
+                        basic_auth_password: basic_auth_password)
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://{subdomain}.{domain}'
+      },
+      Environment::ENVIRONMENT2 => {
+        Server::DEFAULT => 'https://events.chargify.com'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      parameters = {
+        'subdomain' => { 'value' => subdomain, 'encode' => false },
+        'domain' => { 'value' => domain, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
+    end
+  end
+end

data/lib/advanced_billing/controllers/advance_invoice_controller.rb

@@ -0,0 +1,115 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # AdvanceInvoiceController
+  class AdvanceInvoiceController < BaseController
+    # Generate an invoice in advance for a subscription's next renewal date.
+    # [Please see our
+    # docs](reference/Chargify-API.v1.yaml/components/schemas/Invoice) for more
+    # information on advance invoices, including eligibility on generating one;
+    # for the most part, they function like any other invoice, except they are
+    # issued early and have special behavior upon being voided.
+    # A subscription may only have one advance invoice per billing period.
+    # Attempting to issue an advance invoice when one already exists will return
+    # an error.
+    # That said, regeneration of the invoice may be forced with the params
+    # `force: true`, which will void an advance invoice if one exists and
+    # generate a new one. If no advance invoice exists, a new one will be
+    # generated.
+    # We recommend using either the create or preview endpoints for proforma
+    # invoices to preview this advance invoice before using this endpoint to
+    # generate it.
+    # @param [Integer] subscription_id Required parameter: The Chargify id of
+    # the subscription
+    # @param [IssueAdvanceInvoiceRequest] body Optional parameter: Example:
+    # @return [Invoice] response from the API call
+    def issue_advance_invoice(subscription_id,
+                              body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscriptions/{subscription_id}/advance_invoice/issue.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: '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(Invoice.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
+
+    # Once an advance invoice has been generated for a subscription's upcoming
+    # renewal, it can be viewed through this endpoint. There can only be one
+    # advance invoice per subscription per billing cycle.
+    # @param [Integer] subscription_id Required parameter: The Chargify id of
+    # the subscription
+    # @return [Invoice] response from the API call
+    def read_advance_invoice(subscription_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/subscriptions/{subscription_id}/advance_invoice.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(Invoice.method(:from_hash))
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException))
+        .execute
+    end
+
+    # Void a subscription's existing advance invoice. Once voided, it can later
+    # be regenerated if desired.
+    # A `reason` is required in order to void, and the invoice must have an open
+    # status. Voiding will cause any prepayments and credits that were applied
+    # to the invoice to be returned to the subscription. For a full overview of
+    # the impact of voiding, please [see our help
+    # docs](reference/Chargify-API.v1.yaml/components/schemas/Invoice).
+    # @param [Integer] subscription_id Required parameter: The Chargify id of
+    # the subscription
+    # @param [VoidInvoiceRequest] body Optional parameter: Example:
+    # @return [Invoice] response from the API call
+    def void_advance_invoice(subscription_id,
+                             body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscriptions/{subscription_id}/advance_invoice/void.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: '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(Invoice.method(:from_hash))
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException))
+        .execute
+    end
+  end
+end

data/lib/advanced_billing/controllers/api_exports_controller.rb

@@ -0,0 +1,262 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # APIExportsController
+  class APIExportsController < BaseController
+    # This API returns an array of exported proforma invoices for a provided
+    # `batch_id`. Pay close attention to pagination in order to control
+    # responses from the server.
+    # Example: `GET
+    # https://{subdomain}.chargify.com/api_exports/proforma_invoices/123/rows?pe
+    # r_page=10000&page=1`.
+    # @param [String] batch_id Required parameter: Id of a Batch Job.
+    # @param [Integer] per_page Optional parameter: This parameter indicates how
+    # many records to fetch in each request.  Default value is 100.  The maximum
+    # allowed values is 10000; any per_page value over 10000 will be changed to
+    # 10000.
+    # @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`.
+    # @return [Array[ProformaInvoice]] response from the API call
+    def list_exported_proforma_invoices(options = {})
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api_exports/proforma_invoices/{batch_id}/rows.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(options['batch_id'], key: 'batch_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
+                   .query_param(new_parameter(options['page'], key: 'page'))
+                   .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)
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException))
+        .execute
+    end
+
+    # This API returns an array of exported invoices for a provided `batch_id`.
+    # Pay close attention to pagination in order to control responses from the
+    # server.
+    # Example: `GET
+    # https://{subdomain}.chargify.com/api_exports/invoices/123/rows?per_page=10
+    # 000&page=1`.
+    # @param [String] batch_id Required parameter: Id of a Batch Job.
+    # @param [Integer] per_page Optional parameter: This parameter indicates how
+    # many records to fetch in each request.  Default value is 100.  The maximum
+    # allowed values is 10000; any per_page value over 10000 will be changed to
+    # 10000.
+    # @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`.
+    # @return [Array[Invoice]] response from the API call
+    def list_exported_invoices(options = {})
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api_exports/invoices/{batch_id}/rows.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(options['batch_id'], key: 'batch_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
+                   .query_param(new_parameter(options['page'], key: 'page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(Invoice.method(:from_hash))
+                   .is_response_array(true)
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException))
+        .execute
+    end
+
+    # This API returns an array of exported subscriptions for a provided
+    # `batch_id`. Pay close attention to pagination in order to control
+    # responses from the server.
+    # Example: `GET
+    # https://{subdomain}.chargify.com/api_exports/subscriptions/123/rows?per_pa
+    # ge=200&page=1`.
+    # @param [String] batch_id Required parameter: Id of a Batch Job.
+    # @param [Integer] per_page Optional parameter: This parameter indicates how
+    # many records to fetch in each request.  Default value is 100.  The maximum
+    # allowed values is 10000; any per_page value over 10000 will be changed to
+    # 10000.
+    # @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`.
+    # @return [Array[Subscription]] response from the API call
+    def list_exported_subscriptions(options = {})
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api_exports/subscriptions/{batch_id}/rows.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(options['batch_id'], key: 'batch_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(options['per_page'], key: 'per_page'))
+                   .query_param(new_parameter(options['page'], key: 'page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(Subscription.method(:from_hash))
+                   .is_response_array(true)
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException))
+        .execute
+    end
+
+    # This API creates a proforma invoices export and returns a batchjob object.
+    # It is only available for Relationship Invoicing architecture.
+    # @return [BatchJobResponse] response from the API call
+    def export_proforma_invoices
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api_exports/proforma_invoices.json',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(BatchJobResponse.method(:from_hash))
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException)
+                   .local_error_template('409',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         SingleErrorResponseException))
+        .execute
+    end
+
+    # This API creates an invoices export and returns a batchjob object.
+    # @return [BatchJobResponse] response from the API call
+    def export_invoices
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api_exports/invoices.json',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(BatchJobResponse.method(:from_hash))
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException)
+                   .local_error_template('409',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         SingleErrorResponseException))
+        .execute
+    end
+
+    # This API creates a subscriptions export and returns a batchjob object.
+    # @return [BatchJobResponse] response from the API call
+    def export_subscriptions
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api_exports/subscriptions.json',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(BatchJobResponse.method(:from_hash))
+                   .local_error_template('409',
+                                         'HTTP Response Not OK. Status code: {$statusCode}.'\
+                                          ' Response: \'{$response.body}\'.',
+                                         SingleErrorResponseException))
+        .execute
+    end
+
+    # This API returns a batchjob object for proforma invoices export.
+    # @param [String] batch_id Required parameter: Id of a Batch Job.
+    # @return [BatchJobResponse] response from the API call
+    def read_proforma_invoices_export(batch_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api_exports/proforma_invoices/{batch_id}.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(batch_id, key: 'batch_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(BatchJobResponse.method(:from_hash))
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException))
+        .execute
+    end
+
+    # This API returns a batchjob object for invoices export.
+    # @param [String] batch_id Required parameter: Id of a Batch Job.
+    # @return [BatchJobResponse] response from the API call
+    def read_invoices_export(batch_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api_exports/invoices/{batch_id}.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(batch_id, key: 'batch_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(BatchJobResponse.method(:from_hash))
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException))
+        .execute
+    end
+
+    # This API returns a batchjob object for subscriptions export.
+    # @param [String] batch_id Required parameter: Id of a Batch Job.
+    # @return [BatchJobResponse] response from the API call
+    def read_subscriptions_export(batch_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api_exports/subscriptions/{batch_id}.json',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(batch_id, key: 'batch_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(BatchJobResponse.method(:from_hash))
+                   .local_error_template('404',
+                                         'Not Found:\'{$response.body}\'',
+                                         APIException))
+        .execute
+    end
+  end
+end

data/lib/advanced_billing/controllers/base_controller.rb

@@ -0,0 +1,75 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BaseController.
+  class BaseController
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'AB SDK Ruby:1.0.0 on OS {os-info}'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message_template('HTTP Response Not OK. Status code:'\
+                                                    ' {$statusCode}. Response: \'{$response.body}'\
+                                                    '\'.')
+                            .exception_type(APIException),
+      '404' => ErrorCase.new
+                        .error_message_template('Not Found:\'{$response.body}\'')
+                        .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new builder for the Api Call instance.
+    # @return [ApiCall] The instance of ApiCall.
+    def new_api_call_builder
+      @api_call.new_builder
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end