maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/billing_manifest_item.rb

@@ -0,0 +1,189 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BillingManifestItem Model.
+  class BillingManifestItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A handle for the line item transaction type
+    # @return [LineItemTransactionType]
+    attr_accessor :transaction_type
+
+    # A handle for the billing manifest line item kind
+    # @return [BillingManifestLineItemKind]
+    attr_accessor :kind
+
+    # A handle for the billing manifest line item kind
+    # @return [Integer]
+    attr_accessor :amount_in_cents
+
+    # A handle for the billing manifest line item kind
+    # @return [String]
+    attr_accessor :memo
+
+    # A handle for the billing manifest line item kind
+    # @return [Integer]
+    attr_accessor :discount_amount_in_cents
+
+    # A handle for the billing manifest line item kind
+    # @return [Integer]
+    attr_accessor :taxable_amount_in_cents
+
+    # A handle for the billing manifest line item kind
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # A handle for the billing manifest line item kind
+    # @return [String]
+    attr_accessor :component_handle
+
+    # A handle for the billing manifest line item kind
+    # @return [String]
+    attr_accessor :component_name
+
+    # A handle for the billing manifest line item kind
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # A handle for the billing manifest line item kind
+    # @return [String]
+    attr_accessor :product_handle
+
+    # A handle for the billing manifest line item kind
+    # @return [String]
+    attr_accessor :product_name
+
+    # A handle for the billing manifest line item kind
+    # @return [String]
+    attr_accessor :period_range_start
+
+    # A handle for the billing manifest line item kind
+    # @return [String]
+    attr_accessor :period_range_end
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash['kind'] = 'kind'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['memo'] = 'memo'
+      @_hash['discount_amount_in_cents'] = 'discount_amount_in_cents'
+      @_hash['taxable_amount_in_cents'] = 'taxable_amount_in_cents'
+      @_hash['component_id'] = 'component_id'
+      @_hash['component_handle'] = 'component_handle'
+      @_hash['component_name'] = 'component_name'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_handle'] = 'product_handle'
+      @_hash['product_name'] = 'product_name'
+      @_hash['period_range_start'] = 'period_range_start'
+      @_hash['period_range_end'] = 'period_range_end'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_type
+        kind
+        amount_in_cents
+        memo
+        discount_amount_in_cents
+        taxable_amount_in_cents
+        component_id
+        component_handle
+        component_name
+        product_id
+        product_handle
+        product_name
+        period_range_start
+        period_range_end
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_type = SKIP,
+                   kind = SKIP,
+                   amount_in_cents = SKIP,
+                   memo = SKIP,
+                   discount_amount_in_cents = SKIP,
+                   taxable_amount_in_cents = SKIP,
+                   component_id = SKIP,
+                   component_handle = SKIP,
+                   component_name = SKIP,
+                   product_id = SKIP,
+                   product_handle = SKIP,
+                   product_name = SKIP,
+                   period_range_start = SKIP,
+                   period_range_end = SKIP)
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @kind = kind unless kind == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @memo = memo unless memo == SKIP
+      @discount_amount_in_cents = discount_amount_in_cents unless discount_amount_in_cents == SKIP
+      @taxable_amount_in_cents = taxable_amount_in_cents unless taxable_amount_in_cents == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @component_handle = component_handle unless component_handle == SKIP
+      @component_name = component_name unless component_name == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_handle = product_handle unless product_handle == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @period_range_start = period_range_start unless period_range_start == SKIP
+      @period_range_end = period_range_end unless period_range_end == 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.
+      transaction_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      discount_amount_in_cents =
+        hash.key?('discount_amount_in_cents') ? hash['discount_amount_in_cents'] : SKIP
+      taxable_amount_in_cents =
+        hash.key?('taxable_amount_in_cents') ? hash['taxable_amount_in_cents'] : SKIP
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      component_handle =
+        hash.key?('component_handle') ? hash['component_handle'] : SKIP
+      component_name =
+        hash.key?('component_name') ? hash['component_name'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_handle =
+        hash.key?('product_handle') ? hash['product_handle'] : SKIP
+      product_name = hash.key?('product_name') ? hash['product_name'] : SKIP
+      period_range_start =
+        hash.key?('period_range_start') ? hash['period_range_start'] : SKIP
+      period_range_end =
+        hash.key?('period_range_end') ? hash['period_range_end'] : SKIP
+
+      # Create object from extracted values.
+      BillingManifestItem.new(transaction_type,
+                              kind,
+                              amount_in_cents,
+                              memo,
+                              discount_amount_in_cents,
+                              taxable_amount_in_cents,
+                              component_id,
+                              component_handle,
+                              component_name,
+                              product_id,
+                              product_handle,
+                              product_name,
+                              period_range_start,
+                              period_range_end)
+    end
+  end
+end

data/lib/advanced_billing/models/billing_manifest_line_item_kind.rb

@@ -0,0 +1,35 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # A handle for the billing manifest line item kind
+  class BillingManifestLineItemKind
+    BILLING_MANIFEST_LINE_ITEM_KIND = [
+      # TODO: Write general description for BASELINE
+      BASELINE = 'baseline'.freeze,
+
+      # TODO: Write general description for INITIAL
+      INITIAL = 'initial'.freeze,
+
+      # TODO: Write general description for TRIAL
+      TRIAL = 'trial'.freeze,
+
+      # TODO: Write general description for COUPON
+      COUPON = 'coupon'.freeze,
+
+      # TODO: Write general description for COMPONENT
+      COMPONENT = 'component'.freeze,
+
+      # TODO: Write general description for TAX
+      TAX = 'tax'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BILLING_MANIFEST_LINE_ITEM_KIND.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/billing_schedule.rb

@@ -0,0 +1,55 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # 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
+  class BillingSchedule < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The initial_billing_at attribute in Maxio allows you to specify a custom
+    # starting date for billing cycles associated with components that have
+    # their own billing frequency set. Only ISO8601 format is supported.
+    # @return [Date]
+    attr_accessor :initial_billing_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['initial_billing_at'] = 'initial_billing_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        initial_billing_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(initial_billing_at = SKIP)
+      @initial_billing_at = initial_billing_at unless initial_billing_at == 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.
+      initial_billing_at =
+        hash.key?('initial_billing_at') ? hash['initial_billing_at'] : SKIP
+
+      # Create object from extracted values.
+      BillingSchedule.new(initial_billing_at)
+    end
+  end
+end

data/lib/advanced_billing/models/breakouts.rb

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

data/lib/advanced_billing/models/bulk_component_s_price_point_assignment.rb

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

data/lib/advanced_billing/models/bulk_create_product_price_points_request.rb

@@ -0,0 +1,57 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BulkCreateProductPricePointsRequest Model.
+  class BulkCreateProductPricePointsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CreateProductPricePoint]]
+    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.
+      # Parameter is an array, so we need to iterate through it
+      price_points = nil
+      unless hash['price_points'].nil?
+        price_points = []
+        hash['price_points'].each do |structure|
+          price_points << (CreateProductPricePoint.from_hash(structure) if structure)
+        end
+      end
+
+      price_points = nil unless hash.key?('price_points')
+
+      # Create object from extracted values.
+      BulkCreateProductPricePointsRequest.new(price_points)
+    end
+  end
+end

data/lib/advanced_billing/models/bulk_create_product_price_points_response.rb

@@ -0,0 +1,59 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # BulkCreateProductPricePointsResponse Model.
+  class BulkCreateProductPricePointsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ProductPricePoint]]
+    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
+      %w[
+        price_points
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(price_points = SKIP)
+      @price_points = price_points unless price_points == 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.
+      # Parameter is an array, so we need to iterate through it
+      price_points = nil
+      unless hash['price_points'].nil?
+        price_points = []
+        hash['price_points'].each do |structure|
+          price_points << (ProductPricePoint.from_hash(structure) if structure)
+        end
+      end
+
+      price_points = SKIP unless hash.key?('price_points')
+
+      # Create object from extracted values.
+      BulkCreateProductPricePointsResponse.new(price_points)
+    end
+  end
+end

data/lib/advanced_billing/models/bulk_create_segments.rb

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

data/lib/advanced_billing/models/bulk_update_segments.rb

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