maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/deduct_service_credit.rb

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

data/lib/advanced_billing/models/deduct_service_credit_request.rb

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

data/lib/advanced_billing/models/delayed_cancellation_response.rb

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

data/lib/advanced_billing/models/delete_subscription_group_response.rb

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

data/lib/advanced_billing/models/direction.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # direction.
+  class Direction
+    DIRECTION = [
+      # TODO: Write general description for ASC
+      ASC = 'asc'.freeze,
+
+      # TODO: Write general description for DESC
+      DESC = 'desc'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DIRECTION.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/discount_type.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Discount Type.
+  class DiscountType
+    DISCOUNT_TYPE = [
+      # TODO: Write general description for AMOUNT
+      AMOUNT = 'amount'.freeze,
+
+      # TODO: Write general description for PERCENT
+      PERCENT = 'percent'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DISCOUNT_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/dunner_data.rb

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

data/lib/advanced_billing/models/dunning_step_data.rb

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

data/lib/advanced_billing/models/dunning_step_reached.rb

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