pnap_invoicing_api 1.0.0

data/lib/pnap_invoicing_api/models/paginated_response.rb

@@ -0,0 +1,256 @@
+=begin
+#Invoicing API
+
+#List, fetch and pay invoices with the Invoicing API. 
+
+The version of the OpenAPI document: 1.0
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module InvoicingApi
+  class PaginatedResponse
+    # Maximum number of items in the page (actual returned length can be less).
+    attr_accessor :limit
+
+    # The number of returned items skipped.
+    attr_accessor :offset
+
+    # The total number of records available for retrieval.
+    attr_accessor :total
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'limit' => :'limit',
+        :'offset' => :'offset',
+        :'total' => :'total'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'limit' => :'Integer',
+        :'offset' => :'Integer',
+        :'total' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `InvoicingApi::PaginatedResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `InvoicingApi::PaginatedResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      else
+        self.limit = nil
+      end
+
+      if attributes.key?(:'offset')
+        self.offset = attributes[:'offset']
+      else
+        self.offset = nil
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      else
+        self.total = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @limit.nil?
+        invalid_properties.push('invalid value for "limit", limit cannot be nil.')
+      end
+
+      if @offset.nil?
+        invalid_properties.push('invalid value for "offset", offset cannot be nil.')
+      end
+
+      if @total.nil?
+        invalid_properties.push('invalid value for "total", total cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @limit.nil?
+      return false if @offset.nil?
+      return false if @total.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          limit == o.limit &&
+          offset == o.offset &&
+          total == o.total
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [limit, offset, total].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = InvoicingApi.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/pnap_invoicing_api/version.rb

@@ -0,0 +1,19 @@
+=begin
+#Invoicing API
+
+#List, fetch and pay invoices with the Invoicing API. 
+
+The version of the OpenAPI document: 1.0
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+def get_version()
+    return File.read(File.expand_path('../../../VERSION', __FILE__)).strip
+end
+
+module InvoicingApi
+  VERSION = get_version()
+end

data/lib/pnap_invoicing_api.rb

@@ -0,0 +1,44 @@
+=begin
+#Invoicing API
+
+#List, fetch and pay invoices with the Invoicing API. 
+
+The version of the OpenAPI document: 1.0
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+# Common files
+require 'pnap_invoicing_api/api_client'
+require 'pnap_invoicing_api/api_error'
+require 'pnap_invoicing_api/version'
+require 'pnap_invoicing_api/configuration'
+
+# Models
+require 'pnap_invoicing_api/models/error'
+require 'pnap_invoicing_api/models/invoice'
+require 'pnap_invoicing_api/models/paginated_invoices'
+require 'pnap_invoicing_api/models/paginated_response'
+
+# APIs
+require 'pnap_invoicing_api/api/invoices_api'
+
+module InvoicingApi
+  class << self
+    # Customize default settings for the SDK using block.
+    #   InvoicingApi.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/pnap_invoicing_api.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Invoicing API
+
+#List, fetch and pay invoices with the Invoicing API. 
+
+The version of the OpenAPI document: 1.0
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "pnap_invoicing_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pnap_invoicing_api"
+  s.version     = InvoicingApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["PhoenixNAP"]
+  s.email       = ["support@phoenixnap.com"]
+  s.homepage    = "https://phoenixnap.com/bare-metal-cloud"
+  s.summary     = "Invoicing API Ruby Gem"
+  s.description = "Invoicing API Ruby Gem"
+  s.license     = "MPL-2.0"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = { "source_code_uri" => "https://github.com/phoenixnap/ruby-sdk-bmc" }
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/invoices_api_spec.rb

@@ -0,0 +1,91 @@
+=begin
+#Invoicing API
+
+#List, fetch and pay invoices with the Invoicing API. 
+
+The version of the OpenAPI document: 1.0
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for InvoicingApi::InvoicesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'InvoicesApi' do
+  before do
+    # run before each test
+    @api_instance = InvoicingApi::InvoicesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InvoicesApi' do
+    it 'should create an instance of InvoicesApi' do
+      expect(@api_instance).to be_instance_of(InvoicingApi::InvoicesApi)
+    end
+  end
+
+  # unit tests for invoices_get
+  # List invoices.
+  # List invoices.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :number A user-friendly reference number assigned to the invoice.
+  # @option opts [String] :status Payment status of the invoice.
+  # @option opts [Time] :sent_on_from Minimum value to filter invoices by sent on date.
+  # @option opts [Time] :sent_on_to Maximum value to filter invoices by sent on date.
+  # @option opts [Integer] :limit The limit of the number of results returned. The number of records returned may be smaller than the limit.
+  # @option opts [Integer] :offset The number of items to skip in the results.
+  # @option opts [String] :sort_field If a sortField is requested, pagination will be done after sorting. Default sorting is by number.
+  # @option opts [String] :sort_direction Sort Given Field depending on the desired direction. Default sorting is descending.
+  # @return [PaginatedInvoices]
+  describe 'invoices_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for invoices_invoice_id_generate_pdf_post
+  # Generate invoice details as PDF.
+  # Generate invoice details as PDF.
+  # @param invoice_id The unique resource identifier of the Invoice.
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'invoices_invoice_id_generate_pdf_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for invoices_invoice_id_get
+  # Get invoice details.
+  # Get invoice details.
+  # @param invoice_id The unique resource identifier of the Invoice.
+  # @param [Hash] opts the optional parameters
+  # @return [Invoice]
+  describe 'invoices_invoice_id_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for invoices_invoice_id_pay_post
+  # Pay an invoice.
+  # Manually pay an invoice.
+  # @param invoice_id The unique resource identifier of the Invoice.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Object] :body 
+  # @return [Object]
+  describe 'invoices_invoice_id_pay_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/error_spec.rb

@@ -0,0 +1,42 @@
+=begin
+#Invoicing API
+
+#List, fetch and pay invoices with the Invoicing API. 
+
+The version of the OpenAPI document: 1.0
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for InvoicingApi::Error
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe InvoicingApi::Error do
+  let(:instance) { InvoicingApi::Error.new }
+
+  describe 'test an instance of Error' do
+    it 'should create an instance of Error' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(InvoicingApi::Error)
+    end
+  end
+
+  describe 'test attribute "message"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "validation_errors"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/invoice_spec.rb

@@ -0,0 +1,78 @@
+=begin
+#Invoicing API
+
+#List, fetch and pay invoices with the Invoicing API. 
+
+The version of the OpenAPI document: 1.0
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for InvoicingApi::Invoice
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe InvoicingApi::Invoice do
+  let(:instance) { InvoicingApi::Invoice.new }
+
+  describe 'test an instance of Invoice' do
+    it 'should create an instance of Invoice' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(InvoicingApi::Invoice)
+    end
+  end
+
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "number"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "currency"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "amount"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "outstanding_amount"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "sent_on"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "due_date"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/paginated_invoices_spec.rb

@@ -0,0 +1,54 @@
+=begin
+#Invoicing API
+
+#List, fetch and pay invoices with the Invoicing API. 
+
+The version of the OpenAPI document: 1.0
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for InvoicingApi::PaginatedInvoices
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe InvoicingApi::PaginatedInvoices do
+  let(:instance) { InvoicingApi::PaginatedInvoices.new }
+
+  describe 'test an instance of PaginatedInvoices' do
+    it 'should create an instance of PaginatedInvoices' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(InvoicingApi::PaginatedInvoices)
+    end
+  end
+
+  describe 'test attribute "results"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "limit"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "offset"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "total"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/paginated_response_spec.rb

@@ -0,0 +1,48 @@
+=begin
+#Invoicing API
+
+#List, fetch and pay invoices with the Invoicing API. 
+
+The version of the OpenAPI document: 1.0
+Contact: support@phoenixnap.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for InvoicingApi::PaginatedResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe InvoicingApi::PaginatedResponse do
+  let(:instance) { InvoicingApi::PaginatedResponse.new }
+
+  describe 'test an instance of PaginatedResponse' do
+    it 'should create an instance of PaginatedResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(InvoicingApi::PaginatedResponse)
+    end
+  end
+
+  describe 'test attribute "limit"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "offset"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "total"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end