maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/create_multi_invoice_payment.rb

@@ -0,0 +1,133 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateMultiInvoicePayment Model.
+  class CreateMultiInvoicePayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A description to be attached to the payment.
+    # @return [String]
+    attr_accessor :memo
+
+    # Additional information related to the payment method (eg. Check #).
+    # @return [String]
+    attr_accessor :details
+
+    # The type of payment method used.
+    # @return [InvoicePaymentMethodType]
+    attr_accessor :method
+
+    # Dollar amount of the sum of the invoices payment (eg. "10.50" => $10.50).
+    # @return [Object]
+    attr_accessor :amount
+
+    # Date reflecting when the payment was received from a customer. Must be in
+    # the past.
+    # @return [String]
+    attr_accessor :received_on
+
+    # Date reflecting when the payment was received from a customer. Must be in
+    # the past.
+    # @return [Array[CreateInvoicePaymentApplication]]
+    attr_accessor :applications
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['memo'] = 'memo'
+      @_hash['details'] = 'details'
+      @_hash['method'] = 'method'
+      @_hash['amount'] = 'amount'
+      @_hash['received_on'] = 'received_on'
+      @_hash['applications'] = 'applications'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        memo
+        details
+        method
+        received_on
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil,
+                   applications = nil,
+                   memo = SKIP,
+                   details = SKIP,
+                   method = InvoicePaymentMethodType::OTHER,
+                   received_on = SKIP)
+      @memo = memo unless memo == SKIP
+      @details = details unless details == SKIP
+      @method = method unless method == SKIP
+      @amount = amount
+      @received_on = received_on unless received_on == SKIP
+      @applications = applications
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = hash.key?('amount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateMultiInvoicePaymentAmount), hash['amount']
+      ) : nil
+      # Parameter is an array, so we need to iterate through it
+      applications = nil
+      unless hash['applications'].nil?
+        applications = []
+        hash['applications'].each do |structure|
+          applications << (CreateInvoicePaymentApplication.from_hash(structure) if structure)
+        end
+      end
+
+      applications = nil unless hash.key?('applications')
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      details = hash.key?('details') ? hash['details'] : SKIP
+      method = hash['method'] ||= InvoicePaymentMethodType::OTHER
+      received_on = hash.key?('received_on') ? hash['received_on'] : SKIP
+
+      # Create object from extracted values.
+      CreateMultiInvoicePayment.new(amount,
+                                    applications,
+                                    memo,
+                                    details,
+                                    method,
+                                    received_on)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateMultiInvoicePayment | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:CreateMultiInvoicePaymentAmount)
+                         .validate(value.amount) and
+            APIHelper.valid_type?(value.applications,
+                                  ->(val) { CreateInvoicePaymentApplication.validate(val) })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:CreateMultiInvoicePaymentAmount)
+                       .validate(value['amount']) and
+          APIHelper.valid_type?(value['applications'],
+                                ->(val) { CreateInvoicePaymentApplication.validate(val) })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/create_multi_invoice_payment_request.rb

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

data/lib/advanced_billing/models/create_offer.rb

@@ -0,0 +1,117 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateOffer Model.
+  class CreateOffer < 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
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_price_point_id
+
+    # TODO: Write general description for this method
+    # @return [Array[CreateOfferComponent]]
+    attr_accessor :components
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :coupons
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
+      @_hash['description'] = 'description'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_price_point_id'] = 'product_price_point_id'
+      @_hash['components'] = 'components'
+      @_hash['coupons'] = 'coupons'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        product_price_point_id
+        components
+        coupons
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   handle = nil,
+                   product_id = nil,
+                   description = SKIP,
+                   product_price_point_id = SKIP,
+                   components = SKIP,
+                   coupons = SKIP)
+      @name = name
+      @handle = handle
+      @description = description unless description == SKIP
+      @product_id = product_id
+      @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
+      @components = components unless components == SKIP
+      @coupons = coupons unless coupons == 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
+      handle = hash.key?('handle') ? hash['handle'] : nil
+      product_id = hash.key?('product_id') ? hash['product_id'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      product_price_point_id =
+        hash.key?('product_price_point_id') ? hash['product_price_point_id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      components = nil
+      unless hash['components'].nil?
+        components = []
+        hash['components'].each do |structure|
+          components << (CreateOfferComponent.from_hash(structure) if structure)
+        end
+      end
+
+      components = SKIP unless hash.key?('components')
+      coupons = hash.key?('coupons') ? hash['coupons'] : SKIP
+
+      # Create object from extracted values.
+      CreateOffer.new(name,
+                      handle,
+                      product_id,
+                      description,
+                      product_price_point_id,
+                      components,
+                      coupons)
+    end
+  end
+end

data/lib/advanced_billing/models/create_offer_component.rb

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

data/lib/advanced_billing/models/create_offer_request.rb

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

data/lib/advanced_billing/models/create_on_off_component.rb

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

data/lib/advanced_billing/models/create_or_update_coupon.rb

@@ -0,0 +1,86 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateOrUpdateCoupon Model.
+  class CreateOrUpdateCoupon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :coupon
+
+    # An object where the keys are product_ids and the values are booleans
+    # indicating if the coupon should be applicable to the product
+    # @return [Hash[String, TrueClass | FalseClass]]
+    attr_accessor :restricted_products
+
+    # An object where the keys are component_ids and the values are booleans
+    # indicating if the coupon should be applicable to the component
+    # @return [Hash[String, TrueClass | FalseClass]]
+    attr_accessor :restricted_components
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['coupon'] = 'coupon'
+      @_hash['restricted_products'] = 'restricted_products'
+      @_hash['restricted_components'] = 'restricted_components'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        coupon
+        restricted_products
+        restricted_components
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(coupon = SKIP,
+                   restricted_products = SKIP,
+                   restricted_components = SKIP)
+      @coupon = coupon unless coupon == SKIP
+      @restricted_products = restricted_products unless restricted_products == SKIP
+      @restricted_components = restricted_components unless restricted_components == 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.
+      coupon = hash.key?('coupon') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateOrUpdateCouponCoupon), hash['coupon']
+      ) : SKIP
+      restricted_products =
+        hash.key?('restricted_products') ? hash['restricted_products'] : SKIP
+      restricted_components =
+        hash.key?('restricted_components') ? hash['restricted_components'] : SKIP
+
+      # Create object from extracted values.
+      CreateOrUpdateCoupon.new(coupon,
+                               restricted_products,
+                               restricted_components)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateOrUpdateCoupon | 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