maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/create_ebb_component.rb

@@ -0,0 +1,49 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateEBBComponent Model.
+  class CreateEBBComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [EBBComponent]
+    attr_accessor :event_based_component
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_based_component'] = 'event_based_component'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(event_based_component = nil)
+      @event_based_component = event_based_component
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      event_based_component = EBBComponent.from_hash(hash['event_based_component']) if
+        hash['event_based_component']
+
+      # Create object from extracted values.
+      CreateEBBComponent.new(event_based_component)
+    end
+  end
+end

data/lib/advanced_billing/models/create_invoice.rb

@@ -0,0 +1,168 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateInvoice Model.
+  class CreateInvoice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CreateInvoiceItem]]
+    attr_accessor :line_items
+
+    # TODO: Write general description for this method
+    # @return [Date]
+    attr_accessor :issue_date
+
+    # By default, invoices will be created with a due date matching the date of
+    # invoice creation. If a different due date is desired, the net_terms
+    # parameter can be sent indicating the number of days in advance the due
+    # date should be.
+    # @return [Integer]
+    attr_accessor :net_terms
+
+    # By default, invoices will be created with a due date matching the date of
+    # invoice creation. If a different due date is desired, the net_terms
+    # parameter can be sent indicating the number of days in advance the due
+    # date should be.
+    # @return [String]
+    attr_accessor :payment_instructions
+
+    # A custom memo can be sent to override the site's default.
+    # @return [String]
+    attr_accessor :memo
+
+    # Overrides the defaults for the site
+    # @return [CreateInvoiceAddress]
+    attr_accessor :seller_address
+
+    # Overrides the default for the customer
+    # @return [CreateInvoiceAddress]
+    attr_accessor :billing_address
+
+    # Overrides the default for the customer
+    # @return [CreateInvoiceAddress]
+    attr_accessor :shipping_address
+
+    # Overrides the default for the customer
+    # @return [Array[CreateInvoiceCoupon]]
+    attr_accessor :coupons
+
+    # Overrides the default for the customer
+    # @return [CreateInvoiceStatus]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line_items'] = 'line_items'
+      @_hash['issue_date'] = 'issue_date'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['payment_instructions'] = 'payment_instructions'
+      @_hash['memo'] = 'memo'
+      @_hash['seller_address'] = 'seller_address'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['coupons'] = 'coupons'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line_items
+        issue_date
+        net_terms
+        payment_instructions
+        memo
+        seller_address
+        billing_address
+        shipping_address
+        coupons
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line_items = SKIP,
+                   issue_date = SKIP,
+                   net_terms = SKIP,
+                   payment_instructions = SKIP,
+                   memo = SKIP,
+                   seller_address = SKIP,
+                   billing_address = SKIP,
+                   shipping_address = SKIP,
+                   coupons = SKIP,
+                   status = CreateInvoiceStatus::OPEN)
+      @line_items = line_items unless line_items == SKIP
+      @issue_date = issue_date unless issue_date == SKIP
+      @net_terms = net_terms unless net_terms == SKIP
+      @payment_instructions = payment_instructions unless payment_instructions == SKIP
+      @memo = memo unless memo == SKIP
+      @seller_address = seller_address unless seller_address == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @coupons = coupons unless coupons == SKIP
+      @status = status unless status == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (CreateInvoiceItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = SKIP unless hash.key?('line_items')
+      issue_date = hash.key?('issue_date') ? hash['issue_date'] : SKIP
+      net_terms = hash.key?('net_terms') ? hash['net_terms'] : SKIP
+      payment_instructions =
+        hash.key?('payment_instructions') ? hash['payment_instructions'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      seller_address = CreateInvoiceAddress.from_hash(hash['seller_address']) if
+        hash['seller_address']
+      billing_address = CreateInvoiceAddress.from_hash(hash['billing_address']) if
+        hash['billing_address']
+      shipping_address = CreateInvoiceAddress.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      # Parameter is an array, so we need to iterate through it
+      coupons = nil
+      unless hash['coupons'].nil?
+        coupons = []
+        hash['coupons'].each do |structure|
+          coupons << (CreateInvoiceCoupon.from_hash(structure) if structure)
+        end
+      end
+
+      coupons = SKIP unless hash.key?('coupons')
+      status = hash['status'] ||= CreateInvoiceStatus::OPEN
+
+      # Create object from extracted values.
+      CreateInvoice.new(line_items,
+                        issue_date,
+                        net_terms,
+                        payment_instructions,
+                        memo,
+                        seller_address,
+                        billing_address,
+                        shipping_address,
+                        coupons,
+                        status)
+    end
+  end
+end

data/lib/advanced_billing/models/create_invoice_address.rb

@@ -0,0 +1,130 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Overrides the default address.
+  class CreateInvoiceAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :first_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :last_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :phone
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :address
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :address_2
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :city
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :state
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :zip
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['phone'] = 'phone'
+      @_hash['address'] = 'address'
+      @_hash['address_2'] = 'address_2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        phone
+        address
+        address_2
+        city
+        state
+        zip
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first_name = SKIP,
+                   last_name = SKIP,
+                   phone = SKIP,
+                   address = SKIP,
+                   address_2 = SKIP,
+                   city = SKIP,
+                   state = SKIP,
+                   zip = SKIP,
+                   country = SKIP)
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @phone = phone unless phone == SKIP
+      @address = address unless address == SKIP
+      @address_2 = address_2 unless address_2 == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @zip = zip unless zip == SKIP
+      @country = country unless country == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      address = hash.key?('address') ? hash['address'] : SKIP
+      address_2 = hash.key?('address_2') ? hash['address_2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+
+      # Create object from extracted values.
+      CreateInvoiceAddress.new(first_name,
+                               last_name,
+                               phone,
+                               address,
+                               address_2,
+                               city,
+                               state,
+                               zip,
+                               country)
+    end
+  end
+end

data/lib/advanced_billing/models/create_invoice_coupon.rb

@@ -0,0 +1,117 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateInvoiceCoupon Model.
+  class CreateInvoiceCoupon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :percentage
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :product_family_id
+
+    # TODO: Write general description for this method
+    # @return [CompoundingStrategy]
+    attr_accessor :compounding_strategy
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['percentage'] = 'percentage'
+      @_hash['amount'] = 'amount'
+      @_hash['description'] = 'description'
+      @_hash['product_family_id'] = 'product_family_id'
+      @_hash['compounding_strategy'] = 'compounding_strategy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        percentage
+        amount
+        description
+        product_family_id
+        compounding_strategy
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP,
+                   percentage = SKIP,
+                   amount = SKIP,
+                   description = SKIP,
+                   product_family_id = SKIP,
+                   compounding_strategy = SKIP)
+      @code = code unless code == SKIP
+      @percentage = percentage unless percentage == SKIP
+      @amount = amount unless amount == SKIP
+      @description = description unless description == SKIP
+      @product_family_id = product_family_id unless product_family_id == SKIP
+      @compounding_strategy = compounding_strategy unless compounding_strategy == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      percentage = hash.key?('percentage') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceCouponPercentage), hash['percentage']
+      ) : SKIP
+      amount = hash.key?('amount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceCouponAmount), hash['amount']
+      ) : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      product_family_id = hash.key?('product_family_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceCouponProductFamilyId), hash['product_family_id']
+      ) : SKIP
+      compounding_strategy =
+        hash.key?('compounding_strategy') ? hash['compounding_strategy'] : SKIP
+
+      # Create object from extracted values.
+      CreateInvoiceCoupon.new(code,
+                              percentage,
+                              amount,
+                              description,
+                              product_family_id,
+                              compounding_strategy)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateInvoiceCoupon | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end

data/lib/advanced_billing/models/create_invoice_item.rb

@@ -0,0 +1,192 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateInvoiceItem Model.
+  class CreateInvoiceItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # The quantity can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or
+    # 0.00000065. If you submit a value with more than 8 decimal places, we will
+    # round it down to the 8th decimal place.
+    # @return [Object]
+    attr_accessor :quantity
+
+    # The unit_price can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or
+    # 0.00000065. If you submit a value with more than 8 decimal places, we will
+    # round it down to the 8th decimal place.
+    # @return [Object]
+    attr_accessor :unit_price
+
+    # Set to true to automatically calculate taxes. Site must be configured to
+    # use and calculate taxes.
+    # If using Avalara, a tax_code parameter must also be sent.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :taxable
+
+    # Set to true to automatically calculate taxes. Site must be configured to
+    # use and calculate taxes.
+    # If using Avalara, a tax_code parameter must also be sent.
+    # @return [String]
+    attr_accessor :tax_code
+
+    # YYYY-MM-DD
+    # @return [String]
+    attr_accessor :period_range_start
+
+    # YYYY-MM-DD
+    # @return [String]
+    attr_accessor :period_range_end
+
+    # Product handle or product id.
+    # @return [Object]
+    attr_accessor :product_id
+
+    # Component handle or component id.
+    # @return [Object]
+    attr_accessor :component_id
+
+    # Price point handle or id. For component.
+    # @return [Object]
+    attr_accessor :price_point_id
+
+    # Price point handle or id. For component.
+    # @return [Object]
+    attr_accessor :product_price_point_id
+
+    # Price point handle or id. For component.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['title'] = 'title'
+      @_hash['quantity'] = 'quantity'
+      @_hash['unit_price'] = 'unit_price'
+      @_hash['taxable'] = 'taxable'
+      @_hash['tax_code'] = 'tax_code'
+      @_hash['period_range_start'] = 'period_range_start'
+      @_hash['period_range_end'] = 'period_range_end'
+      @_hash['product_id'] = 'product_id'
+      @_hash['component_id'] = 'component_id'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['product_price_point_id'] = 'product_price_point_id'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        title
+        quantity
+        unit_price
+        taxable
+        tax_code
+        period_range_start
+        period_range_end
+        product_id
+        component_id
+        price_point_id
+        product_price_point_id
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(title = SKIP,
+                   quantity = SKIP,
+                   unit_price = SKIP,
+                   taxable = SKIP,
+                   tax_code = SKIP,
+                   period_range_start = SKIP,
+                   period_range_end = SKIP,
+                   product_id = SKIP,
+                   component_id = SKIP,
+                   price_point_id = SKIP,
+                   product_price_point_id = SKIP,
+                   description = SKIP)
+      @title = title unless title == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @taxable = taxable unless taxable == SKIP
+      @tax_code = tax_code unless tax_code == SKIP
+      @period_range_start = period_range_start unless period_range_start == SKIP
+      @period_range_end = period_range_end unless period_range_end == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
+      @description = description unless description == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      title = hash.key?('title') ? hash['title'] : SKIP
+      quantity = hash.key?('quantity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemQuantity), hash['quantity']
+      ) : SKIP
+      unit_price = hash.key?('unit_price') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemUnitPrice), hash['unit_price']
+      ) : SKIP
+      taxable = hash.key?('taxable') ? hash['taxable'] : SKIP
+      tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
+      period_range_start =
+        hash.key?('period_range_start') ? hash['period_range_start'] : SKIP
+      period_range_end =
+        hash.key?('period_range_end') ? hash['period_range_end'] : SKIP
+      product_id = hash.key?('product_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemProductId), hash['product_id']
+      ) : SKIP
+      component_id = hash.key?('component_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemComponentId), hash['component_id']
+      ) : SKIP
+      price_point_id = hash.key?('price_point_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemPricePointId), hash['price_point_id']
+      ) : SKIP
+      product_price_point_id = hash.key?('product_price_point_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemProductPricePointId), hash['product_price_point_id']
+      ) : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      CreateInvoiceItem.new(title,
+                            quantity,
+                            unit_price,
+                            taxable,
+                            tax_code,
+                            period_range_start,
+                            period_range_end,
+                            product_id,
+                            component_id,
+                            price_point_id,
+                            product_price_point_id,
+                            description)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateInvoiceItem | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end