subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/segment_price.rb

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

data/lib/advanced_billing/models/seller.rb

@@ -0,0 +1,89 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Seller Model.
+  class Seller < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [InvoiceAddress]
+    attr_accessor :address
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :phone
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :logo_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['address'] = 'address'
+      @_hash['phone'] = 'phone'
+      @_hash['logo_url'] = 'logo_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        address
+        phone
+        logo_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        logo_url
+      ]
+    end
+
+    def initialize(name = SKIP, address = SKIP, phone = SKIP, logo_url = SKIP)
+      @name = name unless name == SKIP
+      @address = address unless address == SKIP
+      @phone = phone unless phone == SKIP
+      @logo_url = logo_url unless logo_url == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      address = InvoiceAddress.from_hash(hash['address']) if hash['address']
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      logo_url = hash.key?('logo_url') ? hash['logo_url'] : SKIP
+
+      # Create object from extracted values.
+      Seller.new(name,
+                 address,
+                 phone,
+                 logo_url)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Seller | 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/send_invoice_request.rb

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

data/lib/advanced_billing/models/service_credit.rb

@@ -0,0 +1,90 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ServiceCredit Model.
+  class ServiceCredit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # The amount in cents of the entry
+    # @return [Integer]
+    attr_accessor :amount_in_cents
+
+    # The new balance for the credit account
+    # @return [Integer]
+    attr_accessor :ending_balance_in_cents
+
+    # The type of entry
+    # @return [ServiceCreditType]
+    attr_accessor :entry_type
+
+    # The memo attached to the entry
+    # @return [String]
+    attr_accessor :memo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['amount_in_cents'] = 'amount_in_cents'
+      @_hash['ending_balance_in_cents'] = 'ending_balance_in_cents'
+      @_hash['entry_type'] = 'entry_type'
+      @_hash['memo'] = 'memo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        amount_in_cents
+        ending_balance_in_cents
+        entry_type
+        memo
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, amount_in_cents = SKIP,
+                   ending_balance_in_cents = SKIP, entry_type = SKIP,
+                   memo = SKIP)
+      @id = id unless id == SKIP
+      @amount_in_cents = amount_in_cents unless amount_in_cents == SKIP
+      @ending_balance_in_cents = ending_balance_in_cents unless ending_balance_in_cents == SKIP
+      @entry_type = entry_type unless entry_type == SKIP
+      @memo = memo unless memo == 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
+      amount_in_cents =
+        hash.key?('amount_in_cents') ? hash['amount_in_cents'] : SKIP
+      ending_balance_in_cents =
+        hash.key?('ending_balance_in_cents') ? hash['ending_balance_in_cents'] : SKIP
+      entry_type = hash.key?('entry_type') ? hash['entry_type'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+
+      # Create object from extracted values.
+      ServiceCredit.new(id,
+                        amount_in_cents,
+                        ending_balance_in_cents,
+                        entry_type,
+                        memo)
+    end
+  end
+end

data/lib/advanced_billing/models/service_credit_response.rb

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

data/lib/advanced_billing/models/service_credit_type.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The type of entry
+  class ServiceCreditType
+    SERVICE_CREDIT_TYPE = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'Credit'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'Debit'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SERVICE_CREDIT_TYPE.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/shipping_address.rb

@@ -0,0 +1,113 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ShippingAddress Model.
+  class ShippingAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :street
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :line2
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :city
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :state
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :zip
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['street'] = 'street'
+      @_hash['line2'] = 'line2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        street
+        line2
+        city
+        state
+        zip
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        street
+        line2
+        city
+        state
+        zip
+        country
+      ]
+    end
+
+    def initialize(street = SKIP, line2 = SKIP, city = SKIP, state = SKIP,
+                   zip = SKIP, country = SKIP)
+      @street = street unless street == SKIP
+      @line2 = line2 unless line2 == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @zip = zip unless zip == SKIP
+      @country = country unless country == 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.
+      street = hash.key?('street') ? hash['street'] : SKIP
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+
+      # Create object from extracted values.
+      ShippingAddress.new(street,
+                          line2,
+                          city,
+                          state,
+                          zip,
+                          country)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ShippingAddress | 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/signup_proforma_preview.rb

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