maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/create_subscription_component.rb

@@ -0,0 +1,127 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateSubscriptionComponent Model.
+  class CreateSubscriptionComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :component_id
+
+    # Used for on/off components only.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enabled
+
+    # Used for metered and events based components.
+    # @return [Integer]
+    attr_accessor :unit_balance
+
+    # Used for quantity based components.
+    # @return [Object]
+    attr_accessor :allocated_quantity
+
+    # Deprecated. Use `allocated_quantity` instead.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # Deprecated. Use `allocated_quantity` instead.
+    # @return [Object]
+    attr_accessor :price_point_id
+
+    # Create or update custom pricing unique to the subscription. Used in place
+    # of `price_point_id`.
+    # @return [ComponentCustomPrice]
+    attr_accessor :custom_price
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['component_id'] = 'component_id'
+      @_hash['enabled'] = 'enabled'
+      @_hash['unit_balance'] = 'unit_balance'
+      @_hash['allocated_quantity'] = 'allocated_quantity'
+      @_hash['quantity'] = 'quantity'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['custom_price'] = 'custom_price'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        component_id
+        enabled
+        unit_balance
+        allocated_quantity
+        quantity
+        price_point_id
+        custom_price
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(component_id = SKIP,
+                   enabled = SKIP,
+                   unit_balance = SKIP,
+                   allocated_quantity = SKIP,
+                   quantity = SKIP,
+                   price_point_id = SKIP,
+                   custom_price = SKIP)
+      @component_id = component_id unless component_id == SKIP
+      @enabled = enabled unless enabled == SKIP
+      @unit_balance = unit_balance unless unit_balance == SKIP
+      @allocated_quantity = allocated_quantity unless allocated_quantity == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @custom_price = custom_price unless custom_price == 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') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateSubscriptionComponentComponentId), hash['component_id']
+      ) : SKIP
+      enabled = hash.key?('enabled') ? hash['enabled'] : SKIP
+      unit_balance = hash.key?('unit_balance') ? hash['unit_balance'] : SKIP
+      allocated_quantity = hash.key?('allocated_quantity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateSubscriptionComponentAllocatedQuantity), hash['allocated_quantity']
+      ) : SKIP
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      price_point_id = hash.key?('price_point_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateSubscriptionComponentPricePointId), hash['price_point_id']
+      ) : SKIP
+      custom_price = ComponentCustomPrice.from_hash(hash['custom_price']) if hash['custom_price']
+
+      # Create object from extracted values.
+      CreateSubscriptionComponent.new(component_id,
+                                      enabled,
+                                      unit_balance,
+                                      allocated_quantity,
+                                      quantity,
+                                      price_point_id,
+                                      custom_price)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateSubscriptionComponent | 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_subscription_group.rb

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

data/lib/advanced_billing/models/create_subscription_group_request.rb

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

data/lib/advanced_billing/models/create_subscription_request.rb

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

data/lib/advanced_billing/models/create_usage.rb

@@ -0,0 +1,88 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateUsage Model.
+  class CreateUsage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # integer by default or decimal number if fractional quantities are enabled
+    # for the component
+    # @return [Float]
+    attr_accessor :quantity
+
+    # integer by default or decimal number if fractional quantities are enabled
+    # for the component
+    # @return [String]
+    attr_accessor :price_point_id
+
+    # integer by default or decimal number if fractional quantities are enabled
+    # for the component
+    # @return [String]
+    attr_accessor :memo
+
+    # This attribute is particularly useful when you need to align billing
+    # events for different components on distinct schedules within a
+    # subscription. Please note this only works for site with Multifrequency
+    # enabled
+    # @return [BillingSchedule]
+    attr_accessor :billing_schedule
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['quantity'] = 'quantity'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['memo'] = 'memo'
+      @_hash['billing_schedule'] = 'billing_schedule'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        quantity
+        price_point_id
+        memo
+        billing_schedule
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(quantity = SKIP,
+                   price_point_id = SKIP,
+                   memo = SKIP,
+                   billing_schedule = SKIP)
+      @quantity = quantity unless quantity == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @memo = memo unless memo == SKIP
+      @billing_schedule = billing_schedule unless billing_schedule == 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.
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      price_point_id =
+        hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      billing_schedule = BillingSchedule.from_hash(hash['billing_schedule']) if
+        hash['billing_schedule']
+
+      # Create object from extracted values.
+      CreateUsage.new(quantity,
+                      price_point_id,
+                      memo,
+                      billing_schedule)
+    end
+  end
+end

data/lib/advanced_billing/models/create_usage_request.rb

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

data/lib/advanced_billing/models/created_prepayment.rb

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

data/lib/advanced_billing/models/credit_account_balance_changed.rb

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