maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/multi_invoice_payment.rb

@@ -0,0 +1,92 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # MultiInvoicePayment Model.
+  class MultiInvoicePayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The numeric ID of the transaction.
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # Dollar amount of the sum of the paid invoices.
+    # @return [String]
+    attr_accessor :total_amount
+
+    # The ISO 4217 currency code (3 character string) representing the currency
+    # of invoice transaction.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # The ISO 4217 currency code (3 character string) representing the currency
+    # of invoice transaction.
+    # @return [Array[InvoicePaymentApplication]]
+    attr_accessor :applications
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['total_amount'] = 'total_amount'
+      @_hash['currency_code'] = 'currency_code'
+      @_hash['applications'] = 'applications'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_id
+        total_amount
+        currency_code
+        applications
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_id = SKIP,
+                   total_amount = SKIP,
+                   currency_code = SKIP,
+                   applications = SKIP)
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @currency_code = currency_code unless currency_code == SKIP
+      @applications = applications unless applications == 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_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : SKIP
+      total_amount = hash.key?('total_amount') ? hash['total_amount'] : SKIP
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      applications = nil
+      unless hash['applications'].nil?
+        applications = []
+        hash['applications'].each do |structure|
+          applications << (InvoicePaymentApplication.from_hash(structure) if structure)
+        end
+      end
+
+      applications = SKIP unless hash.key?('applications')
+
+      # Create object from extracted values.
+      MultiInvoicePayment.new(transaction_id,
+                              total_amount,
+                              currency_code,
+                              applications)
+    end
+  end
+end

data/lib/advanced_billing/models/multi_invoice_payment_response.rb

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

data/lib/advanced_billing/models/nested_subscription_group.rb

@@ -0,0 +1,94 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # NestedSubscriptionGroup Model.
+  class NestedSubscriptionGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The UID for the group
+    # @return [String]
+    attr_accessor :uid
+
+    # Whether the group is configured to rely on a primary subscription for
+    # billing. At this time, it will always be 1.
+    # @return [Integer]
+    attr_accessor :scheme
+
+    # The subscription ID of the primary within the group. Applicable to scheme
+    # 1.
+    # @return [Integer]
+    attr_accessor :primary_subscription_id
+
+    # A boolean indicating whether the subscription is the primary in the group.
+    # Applicable to scheme 1.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :primary
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['scheme'] = 'scheme'
+      @_hash['primary_subscription_id'] = 'primary_subscription_id'
+      @_hash['primary'] = 'primary'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        scheme
+        primary_subscription_id
+        primary
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP,
+                   scheme = SKIP,
+                   primary_subscription_id = SKIP,
+                   primary = SKIP)
+      @uid = uid unless uid == SKIP
+      @scheme = scheme unless scheme == SKIP
+      @primary_subscription_id = primary_subscription_id unless primary_subscription_id == SKIP
+      @primary = primary unless primary == 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
+      scheme = hash.key?('scheme') ? hash['scheme'] : SKIP
+      primary_subscription_id =
+        hash.key?('primary_subscription_id') ? hash['primary_subscription_id'] : SKIP
+      primary = hash.key?('primary') ? hash['primary'] : SKIP
+
+      # Create object from extracted values.
+      NestedSubscriptionGroup.new(uid,
+                                  scheme,
+                                  primary_subscription_id,
+                                  primary)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [NestedSubscriptionGroup | 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/net_terms.rb

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

data/lib/advanced_billing/models/offer.rb

@@ -0,0 +1,266 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Offer Model.
+  class Offer < 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 :site_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_family_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_price_point_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_revisable_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :handle
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :updated_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :archived_at
+
+    # TODO: Write general description for this method
+    # @return [Array[OfferItem]]
+    attr_accessor :offer_items
+
+    # TODO: Write general description for this method
+    # @return [Array[OfferDiscount]]
+    attr_accessor :offer_discounts
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_family_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_price_point_name
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_price_in_cents
+
+    # TODO: Write general description for this method
+    # @return [Array[OfferSignupPage]]
+    attr_accessor :offer_signup_pages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['site_id'] = 'site_id'
+      @_hash['product_family_id'] = 'product_family_id'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_price_point_id'] = 'product_price_point_id'
+      @_hash['product_revisable_number'] = 'product_revisable_number'
+      @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
+      @_hash['description'] = 'description'
+      @_hash['created_at'] = 'created_at'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['archived_at'] = 'archived_at'
+      @_hash['offer_items'] = 'offer_items'
+      @_hash['offer_discounts'] = 'offer_discounts'
+      @_hash['product_family_name'] = 'product_family_name'
+      @_hash['product_name'] = 'product_name'
+      @_hash['product_price_point_name'] = 'product_price_point_name'
+      @_hash['product_price_in_cents'] = 'product_price_in_cents'
+      @_hash['offer_signup_pages'] = 'offer_signup_pages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        site_id
+        product_family_id
+        product_id
+        product_price_point_id
+        product_revisable_number
+        name
+        handle
+        description
+        created_at
+        updated_at
+        archived_at
+        offer_items
+        offer_discounts
+        product_family_name
+        product_name
+        product_price_point_name
+        product_price_in_cents
+        offer_signup_pages
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        archived_at
+      ]
+    end
+
+    def initialize(id = SKIP,
+                   site_id = SKIP,
+                   product_family_id = SKIP,
+                   product_id = SKIP,
+                   product_price_point_id = SKIP,
+                   product_revisable_number = SKIP,
+                   name = SKIP,
+                   handle = SKIP,
+                   description = SKIP,
+                   created_at = SKIP,
+                   updated_at = SKIP,
+                   archived_at = SKIP,
+                   offer_items = SKIP,
+                   offer_discounts = SKIP,
+                   product_family_name = SKIP,
+                   product_name = SKIP,
+                   product_price_point_name = SKIP,
+                   product_price_in_cents = SKIP,
+                   offer_signup_pages = SKIP)
+      @id = id unless id == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @product_family_id = product_family_id unless product_family_id == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
+      @product_revisable_number = product_revisable_number unless product_revisable_number == SKIP
+      @name = name unless name == SKIP
+      @handle = handle unless handle == SKIP
+      @description = description unless description == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @archived_at = archived_at unless archived_at == SKIP
+      @offer_items = offer_items unless offer_items == SKIP
+      @offer_discounts = offer_discounts unless offer_discounts == SKIP
+      @product_family_name = product_family_name unless product_family_name == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @product_price_point_name = product_price_point_name unless product_price_point_name == SKIP
+      @product_price_in_cents = product_price_in_cents unless product_price_in_cents == SKIP
+      @offer_signup_pages = offer_signup_pages unless offer_signup_pages == 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_id = hash.key?('site_id') ? hash['site_id'] : SKIP
+      product_family_id =
+        hash.key?('product_family_id') ? hash['product_family_id'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_price_point_id =
+        hash.key?('product_price_point_id') ? hash['product_price_point_id'] : SKIP
+      product_revisable_number =
+        hash.key?('product_revisable_number') ? hash['product_revisable_number'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      archived_at = hash.key?('archived_at') ? hash['archived_at'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      offer_items = nil
+      unless hash['offer_items'].nil?
+        offer_items = []
+        hash['offer_items'].each do |structure|
+          offer_items << (OfferItem.from_hash(structure) if structure)
+        end
+      end
+
+      offer_items = SKIP unless hash.key?('offer_items')
+      # Parameter is an array, so we need to iterate through it
+      offer_discounts = nil
+      unless hash['offer_discounts'].nil?
+        offer_discounts = []
+        hash['offer_discounts'].each do |structure|
+          offer_discounts << (OfferDiscount.from_hash(structure) if structure)
+        end
+      end
+
+      offer_discounts = SKIP unless hash.key?('offer_discounts')
+      product_family_name =
+        hash.key?('product_family_name') ? hash['product_family_name'] : SKIP
+      product_name = hash.key?('product_name') ? hash['product_name'] : SKIP
+      product_price_point_name =
+        hash.key?('product_price_point_name') ? hash['product_price_point_name'] : SKIP
+      product_price_in_cents =
+        hash.key?('product_price_in_cents') ? hash['product_price_in_cents'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      offer_signup_pages = nil
+      unless hash['offer_signup_pages'].nil?
+        offer_signup_pages = []
+        hash['offer_signup_pages'].each do |structure|
+          offer_signup_pages << (OfferSignupPage.from_hash(structure) if structure)
+        end
+      end
+
+      offer_signup_pages = SKIP unless hash.key?('offer_signup_pages')
+
+      # Create object from extracted values.
+      Offer.new(id,
+                site_id,
+                product_family_id,
+                product_id,
+                product_price_point_id,
+                product_revisable_number,
+                name,
+                handle,
+                description,
+                created_at,
+                updated_at,
+                archived_at,
+                offer_items,
+                offer_discounts,
+                product_family_name,
+                product_name,
+                product_price_point_name,
+                product_price_in_cents,
+                offer_signup_pages)
+    end
+  end
+end

data/lib/advanced_billing/models/offer_discount.rb

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