maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/create_component_price_point.rb

@@ -0,0 +1,163 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateComponentPricePoint Model.
+  class CreateComponentPricePoint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :handle
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [PricingScheme]
+    attr_accessor :pricing_scheme
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Array[Price]]
+    attr_accessor :prices
+
+    # Whether to use the site level exchange rate or define your own prices for
+    # each currency if you have multiple currencies defined on the site.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_site_exchange_rate
+
+    # Whether or not the price point includes tax
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_included
+
+    # The numerical interval. i.e. an interval of ‘30’ coupled with an
+    # interval_unit of day would mean this price point would renew every 30
+    # days. This property is only available for sites with Multifrequency
+    # enabled.
+    # @return [Integer]
+    attr_accessor :interval
+
+    # A string representing the interval unit for this price point, either month
+    # or day. This property is only available for sites with Multifrequency
+    # enabled.
+    # @return [IntervalUnit]
+    attr_accessor :interval_unit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['prices'] = 'prices'
+      @_hash['use_site_exchange_rate'] = 'use_site_exchange_rate'
+      @_hash['tax_included'] = 'tax_included'
+      @_hash['interval'] = 'interval'
+      @_hash['interval_unit'] = 'interval_unit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        handle
+        use_site_exchange_rate
+        tax_included
+        interval
+        interval_unit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   pricing_scheme = nil,
+                   prices = nil,
+                   handle = SKIP,
+                   use_site_exchange_rate = true,
+                   tax_included = SKIP,
+                   interval = SKIP,
+                   interval_unit = SKIP)
+      @name = name
+      @handle = handle unless handle == SKIP
+      @pricing_scheme = pricing_scheme
+      @prices = prices
+      @use_site_exchange_rate = use_site_exchange_rate unless use_site_exchange_rate == SKIP
+      @tax_included = tax_included unless tax_included == SKIP
+      @interval = interval unless interval == SKIP
+      @interval_unit = interval_unit unless interval_unit == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : nil
+      # Parameter is an array, so we need to iterate through it
+      prices = nil
+      unless hash['prices'].nil?
+        prices = []
+        hash['prices'].each do |structure|
+          prices << (Price.from_hash(structure) if structure)
+        end
+      end
+
+      prices = nil unless hash.key?('prices')
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      use_site_exchange_rate = hash['use_site_exchange_rate'] ||= true
+      tax_included = hash.key?('tax_included') ? hash['tax_included'] : SKIP
+      interval = hash.key?('interval') ? hash['interval'] : SKIP
+      interval_unit = hash.key?('interval_unit') ? hash['interval_unit'] : SKIP
+
+      # Create object from extracted values.
+      CreateComponentPricePoint.new(name,
+                                    pricing_scheme,
+                                    prices,
+                                    handle,
+                                    use_site_exchange_rate,
+                                    tax_included,
+                                    interval,
+                                    interval_unit)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateComponentPricePoint | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.name,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.pricing_scheme,
+                                  ->(val) { PricingScheme.validate(val) }) and
+            APIHelper.valid_type?(value.prices,
+                                  ->(val) { Price.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['name'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['pricing_scheme'],
+                                ->(val) { PricingScheme.validate(val) }) and
+          APIHelper.valid_type?(value['prices'],
+                                ->(val) { Price.validate(val) })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/create_component_price_point_request.rb

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

data/lib/advanced_billing/models/create_component_price_points_request.rb

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

data/lib/advanced_billing/models/create_currency_price.rb

@@ -0,0 +1,70 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateCurrencyPrice Model.
+  class CreateCurrencyPrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO code for a currency defined on the site level
+    # @return [String]
+    attr_accessor :currency
+
+    # Price for the price level in this currency
+    # @return [Float]
+    attr_accessor :price
+
+    # ID of the price that this corresponds with
+    # @return [Integer]
+    attr_accessor :price_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['price'] = 'price'
+      @_hash['price_id'] = 'price_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+        price
+        price_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency = SKIP,
+                   price = SKIP,
+                   price_id = SKIP)
+      @currency = currency unless currency == SKIP
+      @price = price unless price == SKIP
+      @price_id = price_id unless price_id == 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.
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      price = hash.key?('price') ? hash['price'] : SKIP
+      price_id = hash.key?('price_id') ? hash['price_id'] : SKIP
+
+      # Create object from extracted values.
+      CreateCurrencyPrice.new(currency,
+                              price,
+                              price_id)
+    end
+  end
+end

data/lib/advanced_billing/models/create_currency_prices_request.rb

@@ -0,0 +1,57 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateCurrencyPricesRequest Model.
+  class CreateCurrencyPricesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CreateCurrencyPrice]]
+    attr_accessor :currency_prices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency_prices'] = 'currency_prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency_prices = nil)
+      @currency_prices = currency_prices
+    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
+      currency_prices = nil
+      unless hash['currency_prices'].nil?
+        currency_prices = []
+        hash['currency_prices'].each do |structure|
+          currency_prices << (CreateCurrencyPrice.from_hash(structure) if structure)
+        end
+      end
+
+      currency_prices = nil unless hash.key?('currency_prices')
+
+      # Create object from extracted values.
+      CreateCurrencyPricesRequest.new(currency_prices)
+    end
+  end
+end

data/lib/advanced_billing/models/create_customer.rb

@@ -0,0 +1,221 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateCustomer Model.
+  class CreateCustomer < 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 :email
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cc_emails
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :organization
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reference
+
+    # 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
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :phone
+
+    # Set a specific language on a customer record.
+    # @return [String]
+    attr_accessor :locale
+
+    # Set a specific language on a customer record.
+    # @return [String]
+    attr_accessor :vat_number
+
+    # Set a specific language on a customer record.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_exempt
+
+    # Set a specific language on a customer record.
+    # @return [String]
+    attr_accessor :tax_exempt_reason
+
+    # The parent ID in Chargify if applicable. Parent is another Customer
+    # object.
+    # @return [Integer]
+    attr_accessor :parent_id
+
+    # 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['email'] = 'email'
+      @_hash['cc_emails'] = 'cc_emails'
+      @_hash['organization'] = 'organization'
+      @_hash['reference'] = 'reference'
+      @_hash['address'] = 'address'
+      @_hash['address_2'] = 'address_2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash['phone'] = 'phone'
+      @_hash['locale'] = 'locale'
+      @_hash['vat_number'] = 'vat_number'
+      @_hash['tax_exempt'] = 'tax_exempt'
+      @_hash['tax_exempt_reason'] = 'tax_exempt_reason'
+      @_hash['parent_id'] = 'parent_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cc_emails
+        organization
+        reference
+        address
+        address_2
+        city
+        state
+        zip
+        country
+        phone
+        locale
+        vat_number
+        tax_exempt
+        tax_exempt_reason
+        parent_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        parent_id
+      ]
+    end
+
+    def initialize(first_name = nil,
+                   last_name = nil,
+                   email = nil,
+                   cc_emails = SKIP,
+                   organization = SKIP,
+                   reference = SKIP,
+                   address = SKIP,
+                   address_2 = SKIP,
+                   city = SKIP,
+                   state = SKIP,
+                   zip = SKIP,
+                   country = SKIP,
+                   phone = SKIP,
+                   locale = SKIP,
+                   vat_number = SKIP,
+                   tax_exempt = SKIP,
+                   tax_exempt_reason = SKIP,
+                   parent_id = SKIP)
+      @first_name = first_name
+      @last_name = last_name
+      @email = email
+      @cc_emails = cc_emails unless cc_emails == SKIP
+      @organization = organization unless organization == SKIP
+      @reference = reference unless reference == 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
+      @phone = phone unless phone == SKIP
+      @locale = locale unless locale == SKIP
+      @vat_number = vat_number unless vat_number == SKIP
+      @tax_exempt = tax_exempt unless tax_exempt == SKIP
+      @tax_exempt_reason = tax_exempt_reason unless tax_exempt_reason == SKIP
+      @parent_id = parent_id unless parent_id == 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'] : nil
+      last_name = hash.key?('last_name') ? hash['last_name'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+      cc_emails = hash.key?('cc_emails') ? hash['cc_emails'] : SKIP
+      organization = hash.key?('organization') ? hash['organization'] : SKIP
+      reference = hash.key?('reference') ? hash['reference'] : 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
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+      vat_number = hash.key?('vat_number') ? hash['vat_number'] : SKIP
+      tax_exempt = hash.key?('tax_exempt') ? hash['tax_exempt'] : SKIP
+      tax_exempt_reason =
+        hash.key?('tax_exempt_reason') ? hash['tax_exempt_reason'] : SKIP
+      parent_id = hash.key?('parent_id') ? hash['parent_id'] : SKIP
+
+      # Create object from extracted values.
+      CreateCustomer.new(first_name,
+                         last_name,
+                         email,
+                         cc_emails,
+                         organization,
+                         reference,
+                         address,
+                         address_2,
+                         city,
+                         state,
+                         zip,
+                         country,
+                         phone,
+                         locale,
+                         vat_number,
+                         tax_exempt,
+                         tax_exempt_reason,
+                         parent_id)
+    end
+  end
+end

data/lib/advanced_billing/models/create_customer_request.rb

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