subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/issue_invoice_event_data.rb

@@ -0,0 +1,115 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Example schema for an `issue_invoice` event
+  class IssueInvoiceEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Consolidation level of the invoice, which is applicable to invoice
+    # consolidation.  It will hold one of the following values:
+    # * "none": A normal invoice with no consolidation.
+    # * "child": An invoice segment which has been combined into a consolidated
+    # invoice.
+    # * "parent": A consolidated invoice, whose contents are composed of invoice
+    # segments.
+    # "Parent" invoices do not have lines of their own, but they have subtotals
+    # and totals which aggregate the member invoice segments.
+    # See also the [invoice consolidation
+    # documentation](https://chargify.zendesk.com/hc/en-us/articles/440774639183
+    # 5).
+    # @return [InvoiceConsolidationLevel]
+    attr_accessor :consolidation_level
+
+    # The status of the invoice before event occurence. See [Invoice
+    # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#lin
+    # e-item-breakdowns) for more.
+    # @return [Status]
+    attr_accessor :from_status
+
+    # The status of the invoice after event occurence. See [Invoice
+    # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#lin
+    # e-item-breakdowns) for more.
+    # @return [Status]
+    attr_accessor :to_status
+
+    # Amount due on the invoice, which is `total_amount - credit_amount -
+    # paid_amount`.
+    # @return [String]
+    attr_accessor :due_amount
+
+    # The invoice total, which is `subtotal_amount - discount_amount +
+    # tax_amount`.'
+    # @return [String]
+    attr_accessor :total_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['consolidation_level'] = 'consolidation_level'
+      @_hash['from_status'] = 'from_status'
+      @_hash['to_status'] = 'to_status'
+      @_hash['due_amount'] = 'due_amount'
+      @_hash['total_amount'] = 'total_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        consolidation_level
+        from_status
+        to_status
+        due_amount
+        total_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(consolidation_level = SKIP, from_status = SKIP,
+                   to_status = SKIP, due_amount = SKIP, total_amount = SKIP)
+      @consolidation_level = consolidation_level unless consolidation_level == SKIP
+      @from_status = from_status unless from_status == SKIP
+      @to_status = to_status unless to_status == SKIP
+      @due_amount = due_amount unless due_amount == SKIP
+      @total_amount = total_amount unless total_amount == 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.
+      consolidation_level =
+        hash.key?('consolidation_level') ? hash['consolidation_level'] : SKIP
+      from_status = hash.key?('from_status') ? hash['from_status'] : SKIP
+      to_status = hash.key?('to_status') ? hash['to_status'] : SKIP
+      due_amount = hash.key?('due_amount') ? hash['due_amount'] : SKIP
+      total_amount = hash.key?('total_amount') ? hash['total_amount'] : SKIP
+
+      # Create object from extracted values.
+      IssueInvoiceEventData.new(consolidation_level,
+                                from_status,
+                                to_status,
+                                due_amount,
+                                total_amount)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [IssueInvoiceEventData | 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/issue_invoice_request.rb

@@ -0,0 +1,63 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # IssueInvoiceRequest Model.
+  class IssueInvoiceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Action taken when payment for an invoice fails:
+    # - `leave_open_invoice` - prepayments and credits applied to invoice;
+    # invoice status set to "open"; email sent to the customer for the issued
+    # invoice (if setting applies); payment failure recorded in the invoice
+    # history. This is the default option.
+    # - `rollback_to_pending` - prepayments and credits not applied; invoice
+    # remains in "pending" status; no email sent to the customer; payment
+    # failure recorded in the invoice history.
+    # - `initiate_dunning` - prepayments and credits applied to the invoice;
+    # invoice status set to "open"; email sent to the customer for the issued
+    # invoice (if setting applies); payment failure recorded in the invoice
+    # history; subscription will  most likely go into "past_due" or "canceled"
+    # state (depending upon net terms and dunning settings).
+    # @return [FailedPaymentAction]
+    attr_accessor :on_failed_payment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['on_failed_payment'] = 'on_failed_payment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        on_failed_payment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(on_failed_payment = FailedPaymentAction::LEAVE_OPEN_INVOICE)
+      @on_failed_payment = on_failed_payment unless on_failed_payment == 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.
+      on_failed_payment =
+        hash['on_failed_payment'] ||= FailedPaymentAction::LEAVE_OPEN_INVOICE
+
+      # Create object from extracted values.
+      IssueInvoiceRequest.new(on_failed_payment)
+    end
+  end
+end

data/lib/advanced_billing/models/issue_service_credit.rb

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

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,134 @@
+# 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) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.current_price_point,
+                                  ->(val) { ItemPricePointData.validate(val) },
+                                  is_model_hash: true)
+        )
+      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) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['current_price_point'],
+                                ->(val) { ItemPricePointData.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/item_price_point_data.rb

@@ -0,0 +1,78 @@
+# 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
+
+    # Validates an instance of the object from a given value.
+    # @param [ItemPricePointData | 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/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