maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/sale_rep_settings.rb

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

data/lib/advanced_billing/models/sale_rep_subscription.rb

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

data/lib/advanced_billing/models/segment.rb

@@ -0,0 +1,210 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Segment Model.
+  class Segment < 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 :component_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :price_point_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :event_based_billing_metric_id
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [PricingScheme]
+    attr_accessor :pricing_scheme
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Object]
+    attr_accessor :segment_property_1_value
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Object]
+    attr_accessor :segment_property_2_value
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Object]
+    attr_accessor :segment_property_3_value
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Object]
+    attr_accessor :segment_property_4_value
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Array[SegmentPrice]]
+    attr_accessor :prices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['component_id'] = 'component_id'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['event_based_billing_metric_id'] =
+        'event_based_billing_metric_id'
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['segment_property_1_value'] = 'segment_property_1_value'
+      @_hash['segment_property_2_value'] = 'segment_property_2_value'
+      @_hash['segment_property_3_value'] = 'segment_property_3_value'
+      @_hash['segment_property_4_value'] = 'segment_property_4_value'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['prices'] = 'prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        component_id
+        price_point_id
+        event_based_billing_metric_id
+        pricing_scheme
+        segment_property_1_value
+        segment_property_2_value
+        segment_property_3_value
+        segment_property_4_value
+        created_at
+        updated_at
+        prices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   component_id = SKIP,
+                   price_point_id = SKIP,
+                   event_based_billing_metric_id = SKIP,
+                   pricing_scheme = SKIP,
+                   segment_property_1_value = SKIP,
+                   segment_property_2_value = SKIP,
+                   segment_property_3_value = SKIP,
+                   segment_property_4_value = SKIP,
+                   created_at = SKIP,
+                   updated_at = SKIP,
+                   prices = SKIP)
+      @id = id unless id == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      unless event_based_billing_metric_id == SKIP
+        @event_based_billing_metric_id =
+          event_based_billing_metric_id
+      end
+      @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
+      @segment_property_1_value = segment_property_1_value unless segment_property_1_value == SKIP
+      @segment_property_2_value = segment_property_2_value unless segment_property_2_value == SKIP
+      @segment_property_3_value = segment_property_3_value unless segment_property_3_value == SKIP
+      @segment_property_4_value = segment_property_4_value unless segment_property_4_value == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @prices = prices unless prices == 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
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      price_point_id =
+        hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
+      event_based_billing_metric_id =
+        hash.key?('event_based_billing_metric_id') ? hash['event_based_billing_metric_id'] : SKIP
+      pricing_scheme =
+        hash.key?('pricing_scheme') ? hash['pricing_scheme'] : SKIP
+      segment_property_1_value = hash.key?('segment_property_1_value') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SegmentSegmentProperty1Value), hash['segment_property_1_value']
+      ) : SKIP
+      segment_property_2_value = hash.key?('segment_property_2_value') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SegmentSegmentProperty2Value), hash['segment_property_2_value']
+      ) : SKIP
+      segment_property_3_value = hash.key?('segment_property_3_value') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SegmentSegmentProperty3Value), hash['segment_property_3_value']
+      ) : SKIP
+      segment_property_4_value = hash.key?('segment_property_4_value') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:SegmentSegmentProperty4Value), hash['segment_property_4_value']
+      ) : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      prices = nil
+      unless hash['prices'].nil?
+        prices = []
+        hash['prices'].each do |structure|
+          prices << (SegmentPrice.from_hash(structure) if structure)
+        end
+      end
+
+      prices = SKIP unless hash.key?('prices')
+
+      # Create object from extracted values.
+      Segment.new(id,
+                  component_id,
+                  price_point_id,
+                  event_based_billing_metric_id,
+                  pricing_scheme,
+                  segment_property_1_value,
+                  segment_property_2_value,
+                  segment_property_3_value,
+                  segment_property_4_value,
+                  created_at,
+                  updated_at,
+                  prices)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Segment | 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/segment_price.rb

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

data/lib/advanced_billing/models/segment_response.rb

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