maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/create_invoice_payment.rb

@@ -0,0 +1,92 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateInvoicePayment Model.
+  class CreateInvoicePayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A string of the dollar amount to be refunded (eg. "10.50" => $10.50)
+    # @return [Object]
+    attr_accessor :amount
+
+    # A description to be attached to the payment.
+    # @return [String]
+    attr_accessor :memo
+
+    # The type of payment method used.
+    # @return [InvoicePaymentMethodType]
+    attr_accessor :method
+
+    # Additional information related to the payment method (eg. Check #)
+    # @return [String]
+    attr_accessor :details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['memo'] = 'memo'
+      @_hash['method'] = 'method'
+      @_hash['details'] = 'details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        memo
+        method
+        details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = SKIP,
+                   memo = SKIP,
+                   method = InvoicePaymentMethodType::OTHER,
+                   details = SKIP)
+      @amount = amount unless amount == SKIP
+      @memo = memo unless memo == SKIP
+      @method = method unless method == SKIP
+      @details = details unless details == 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.
+      amount = hash.key?('amount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoicePaymentAmount), hash['amount']
+      ) : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      method = hash['method'] ||= InvoicePaymentMethodType::OTHER
+      details = hash.key?('details') ? hash['details'] : SKIP
+
+      # Create object from extracted values.
+      CreateInvoicePayment.new(amount,
+                               memo,
+                               method,
+                               details)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateInvoicePayment | 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_payment_application.rb

@@ -0,0 +1,58 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateInvoicePaymentApplication Model.
+  class CreateInvoicePaymentApplication < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the invoice. It has the prefix "inv_" followed by
+    # alphanumeric characters.
+    # @return [String]
+    attr_accessor :invoice_uid
+
+    # Dollar amount of the invoice payment (eg. "10.50" => $10.50).
+    # @return [String]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice_uid'] = 'invoice_uid'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(invoice_uid = nil,
+                   amount = nil)
+      @invoice_uid = invoice_uid
+      @amount = amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      invoice_uid = hash.key?('invoice_uid') ? hash['invoice_uid'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+
+      # Create object from extracted values.
+      CreateInvoicePaymentApplication.new(invoice_uid,
+                                          amount)
+    end
+  end
+end

data/lib/advanced_billing/models/create_invoice_payment_request.rb

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

data/lib/advanced_billing/models/create_invoice_request.rb

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

data/lib/advanced_billing/models/create_invoice_status.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Create Invoice Status.
+  class CreateInvoiceStatus
+    CREATE_INVOICE_STATUS = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'draft'.freeze,
+
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CREATE_INVOICE_STATUS.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/create_metadata.rb

@@ -0,0 +1,60 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateMetadata Model.
+  class CreateMetadata < 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 :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP,
+                   value = SKIP)
+      @name = name unless name == SKIP
+      @value = value unless value == 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'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      CreateMetadata.new(name,
+                         value)
+    end
+  end
+end

data/lib/advanced_billing/models/create_metadata_request.rb

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

data/lib/advanced_billing/models/create_metafield.rb

@@ -0,0 +1,96 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateMetafield Model.
+  class CreateMetafield < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # Warning: When updating a metafield's scope attribute, all scope attributes
+    # must be passed. Partially complete scope attributes will override the
+    # existing settings.
+    # @return [MetafieldScope]
+    attr_accessor :scope
+
+    # Indicates how data should be added to the metafield. For example, a text
+    # type is just a string, so a given metafield of this type can have any
+    # value attached. On the other hand, dropdown and radio have a set of
+    # allowed values that can be input, and appear differently on a Public
+    # Signup Page. Defaults to 'text'
+    # @return [MetafieldInput]
+    attr_accessor :input_type
+
+    # Only applicable when input_type is radio or dropdown
+    # @return [Array[String]]
+    attr_accessor :enum
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['scope'] = 'scope'
+      @_hash['input_type'] = 'input_type'
+      @_hash['enum'] = 'enum'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        scope
+        input_type
+        enum
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP,
+                   scope = SKIP,
+                   input_type = SKIP,
+                   enum = SKIP)
+      @name = name unless name == SKIP
+      @scope = scope unless scope == SKIP
+      @input_type = input_type unless input_type == SKIP
+      @enum = enum unless enum == 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'] : SKIP
+      scope = MetafieldScope.from_hash(hash['scope']) if hash['scope']
+      input_type = hash.key?('input_type') ? hash['input_type'] : SKIP
+      enum = hash.key?('enum') ? hash['enum'] : SKIP
+
+      # Create object from extracted values.
+      CreateMetafield.new(name,
+                          scope,
+                          input_type,
+                          enum)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateMetafield | 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_metafields_request.rb

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

data/lib/advanced_billing/models/create_metered_component.rb

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