maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/issue_service_credit_request.rb

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

data/lib/advanced_billing/models/item_category.rb

@@ -0,0 +1,33 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # One of the following: Business Software, Consumer Software, Digital
+  # Services, Physical Goods, Other
+  class ItemCategory
+    ITEM_CATEGORY = [
+      # TODO: Write general description for ENUM_BUSINESS_SOFTWARE
+      ENUM_BUSINESS_SOFTWARE = 'Business Software'.freeze,
+
+      # TODO: Write general description for ENUM_CONSUMER_SOFTWARE
+      ENUM_CONSUMER_SOFTWARE = 'Consumer Software'.freeze,
+
+      # TODO: Write general description for ENUM_DIGITAL_SERVICES
+      ENUM_DIGITAL_SERVICES = 'Digital Services'.freeze,
+
+      # TODO: Write general description for ENUM_PHYSICAL_GOODS
+      ENUM_PHYSICAL_GOODS = 'Physical Goods'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'Other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ITEM_CATEGORY.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/item_price_point_changed.rb

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

data/lib/advanced_billing/models/item_price_point_data.rb

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

data/lib/advanced_billing/models/line_item_kind.rb

@@ -0,0 +1,47 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # A handle for the line item kind
+  class LineItemKind
+    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 QUANTITY_BASED_COMPONENT
+      QUANTITY_BASED_COMPONENT = 'quantity_based_component'.freeze,
+
+      # TODO: Write general description for PREPAID_USAGE_COMPONENT
+      PREPAID_USAGE_COMPONENT = 'prepaid_usage_component'.freeze,
+
+      # TODO: Write general description for ON_OFF_COMPONENT
+      ON_OFF_COMPONENT = 'on_off_component'.freeze,
+
+      # TODO: Write general description for METERED_COMPONENT
+      METERED_COMPONENT = 'metered_component'.freeze,
+
+      # TODO: Write general description for EVENT_BASED_COMPONENT
+      EVENT_BASED_COMPONENT = 'event_based_component'.freeze,
+
+      # TODO: Write general description for COUPON
+      COUPON = 'coupon'.freeze,
+
+      # TODO: Write general description for TAX
+      TAX = 'tax'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LINE_ITEM_KIND.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/line_item_transaction_type.rb

@@ -0,0 +1,38 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # A handle for the line item transaction type
+  class LineItemTransactionType
+    LINE_ITEM_TRANSACTION_TYPE = [
+      # TODO: Write general description for CHARGE
+      CHARGE = 'charge'.freeze,
+
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze,
+
+      # TODO: Write general description for ADJUSTMENT
+      ADJUSTMENT = 'adjustment'.freeze,
+
+      # TODO: Write general description for PAYMENT
+      PAYMENT = 'payment'.freeze,
+
+      # TODO: Write general description for REFUND
+      REFUND = 'refund'.freeze,
+
+      # TODO: Write general description for INFO_TRANSACTION
+      INFO_TRANSACTION = 'info_transaction'.freeze,
+
+      # TODO: Write general description for PAYMENT_AUTHORIZATION
+      PAYMENT_AUTHORIZATION = 'payment_authorization'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LINE_ITEM_TRANSACTION_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/list_components_price_points_include.rb

@@ -0,0 +1,20 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # List Components Price Points Include.
+  class ListComponentsPricePointsInclude
+    LIST_COMPONENTS_PRICE_POINTS_INCLUDE = [
+      # TODO: Write general description for CURRENCY_PRICES
+      CURRENCY_PRICES = 'currency_prices'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LIST_COMPONENTS_PRICE_POINTS_INCLUDE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/list_components_price_points_response.rb

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

data/lib/advanced_billing/models/list_credit_notes_response.rb

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

data/lib/advanced_billing/models/list_events_date_field.rb

@@ -0,0 +1,20 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # List Events Date Field.
+  class ListEventsDateField
+    LIST_EVENTS_DATE_FIELD = [
+      # TODO: Write general description for CREATED_AT
+      CREATED_AT = 'created_at'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LIST_EVENTS_DATE_FIELD.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/list_invoice_events_response.rb

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

data/lib/advanced_billing/models/list_invoices_response.rb

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