subtain-apimatic-sdk 4.1.1 → 9.1.2

data/lib/advanced_billing/models/create_invoice_address.rb

@@ -0,0 +1,124 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Overrides the default address.
+  class CreateInvoiceAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :first_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :last_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :phone
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :address
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :address_2
+
+    # 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['first_name'] = 'first_name'
+      @_hash['last_name'] = 'last_name'
+      @_hash['phone'] = 'phone'
+      @_hash['address'] = 'address'
+      @_hash['address_2'] = 'address_2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        phone
+        address
+        address_2
+        city
+        state
+        zip
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first_name = SKIP, last_name = SKIP, phone = SKIP,
+                   address = SKIP, address_2 = SKIP, city = SKIP, state = SKIP,
+                   zip = SKIP, country = SKIP)
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @phone = phone unless phone == SKIP
+      @address = address unless address == SKIP
+      @address_2 = address_2 unless address_2 == 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.
+      first_name = hash.key?('first_name') ? hash['first_name'] : SKIP
+      last_name = hash.key?('last_name') ? hash['last_name'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      address = hash.key?('address') ? hash['address'] : SKIP
+      address_2 = hash.key?('address_2') ? hash['address_2'] : 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.
+      CreateInvoiceAddress.new(first_name,
+                               last_name,
+                               phone,
+                               address,
+                               address_2,
+                               city,
+                               state,
+                               zip,
+                               country)
+    end
+  end
+end

data/lib/advanced_billing/models/create_invoice_coupon.rb

@@ -0,0 +1,115 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateInvoiceCoupon Model.
+  class CreateInvoiceCoupon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :percentage
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :product_family_id
+
+    # TODO: Write general description for this method
+    # @return [CompoundingStrategy]
+    attr_accessor :compounding_strategy
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['percentage'] = 'percentage'
+      @_hash['amount'] = 'amount'
+      @_hash['description'] = 'description'
+      @_hash['product_family_id'] = 'product_family_id'
+      @_hash['compounding_strategy'] = 'compounding_strategy'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        percentage
+        amount
+        description
+        product_family_id
+        compounding_strategy
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, percentage = SKIP, amount = SKIP,
+                   description = SKIP, product_family_id = SKIP,
+                   compounding_strategy = SKIP)
+      @code = code unless code == SKIP
+      @percentage = percentage unless percentage == SKIP
+      @amount = amount unless amount == SKIP
+      @description = description unless description == SKIP
+      @product_family_id = product_family_id unless product_family_id == SKIP
+      @compounding_strategy = compounding_strategy unless compounding_strategy == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      percentage = hash.key?('percentage') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceCouponPercentage), hash['percentage']
+      ) : SKIP
+      amount = hash.key?('amount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceCouponAmount), hash['amount']
+      ) : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      product_family_id = hash.key?('product_family_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceCouponProductFamilyId), hash['product_family_id']
+      ) : SKIP
+      compounding_strategy = hash.key?('compounding_strategy') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceCouponCompoundingStrategy), hash['compounding_strategy']
+      ) : SKIP
+
+      # Create object from extracted values.
+      CreateInvoiceCoupon.new(code,
+                              percentage,
+                              amount,
+                              description,
+                              product_family_id,
+                              compounding_strategy)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateInvoiceCoupon | 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/create_invoice_item.rb

@@ -0,0 +1,185 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateInvoiceItem Model.
+  class CreateInvoiceItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # The quantity can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or
+    # 0.00000065. If you submit a value with more than 8 decimal places, we will
+    # round it down to the 8th decimal place.
+    # @return [Object]
+    attr_accessor :quantity
+
+    # The unit_price can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or
+    # 0.00000065. If you submit a value with more than 8 decimal places, we will
+    # round it down to the 8th decimal place.
+    # @return [Object]
+    attr_accessor :unit_price
+
+    # Set to true to automatically calculate taxes. Site must be configured to
+    # use and calculate taxes.
+    # If using Avalara, a tax_code parameter must also be sent.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :taxable
+
+    # Set to true to automatically calculate taxes. Site must be configured to
+    # use and calculate taxes.
+    # If using Avalara, a tax_code parameter must also be sent.
+    # @return [String]
+    attr_accessor :tax_code
+
+    # YYYY-MM-DD
+    # @return [String]
+    attr_accessor :period_range_start
+
+    # YYYY-MM-DD
+    # @return [String]
+    attr_accessor :period_range_end
+
+    # Product handle or product id.
+    # @return [Object]
+    attr_accessor :product_id
+
+    # Component handle or component id.
+    # @return [Object]
+    attr_accessor :component_id
+
+    # Price point handle or id. For component.
+    # @return [Object]
+    attr_accessor :price_point_id
+
+    # Price point handle or id. For component.
+    # @return [Object]
+    attr_accessor :product_price_point_id
+
+    # Price point handle or id. For component.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['title'] = 'title'
+      @_hash['quantity'] = 'quantity'
+      @_hash['unit_price'] = 'unit_price'
+      @_hash['taxable'] = 'taxable'
+      @_hash['tax_code'] = 'tax_code'
+      @_hash['period_range_start'] = 'period_range_start'
+      @_hash['period_range_end'] = 'period_range_end'
+      @_hash['product_id'] = 'product_id'
+      @_hash['component_id'] = 'component_id'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['product_price_point_id'] = 'product_price_point_id'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        title
+        quantity
+        unit_price
+        taxable
+        tax_code
+        period_range_start
+        period_range_end
+        product_id
+        component_id
+        price_point_id
+        product_price_point_id
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(title = SKIP, quantity = SKIP, unit_price = SKIP,
+                   taxable = SKIP, tax_code = SKIP, period_range_start = SKIP,
+                   period_range_end = SKIP, product_id = SKIP,
+                   component_id = SKIP, price_point_id = SKIP,
+                   product_price_point_id = SKIP, description = SKIP)
+      @title = title unless title == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @taxable = taxable unless taxable == SKIP
+      @tax_code = tax_code unless tax_code == SKIP
+      @period_range_start = period_range_start unless period_range_start == SKIP
+      @period_range_end = period_range_end unless period_range_end == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
+      @description = description unless description == 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.
+      title = hash.key?('title') ? hash['title'] : SKIP
+      quantity = hash.key?('quantity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemQuantity), hash['quantity']
+      ) : SKIP
+      unit_price = hash.key?('unit_price') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemUnitPrice), hash['unit_price']
+      ) : SKIP
+      taxable = hash.key?('taxable') ? hash['taxable'] : SKIP
+      tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
+      period_range_start =
+        hash.key?('period_range_start') ? hash['period_range_start'] : SKIP
+      period_range_end =
+        hash.key?('period_range_end') ? hash['period_range_end'] : SKIP
+      product_id = hash.key?('product_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemProductId), hash['product_id']
+      ) : SKIP
+      component_id = hash.key?('component_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemComponentId), hash['component_id']
+      ) : SKIP
+      price_point_id = hash.key?('price_point_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemPricePointId), hash['price_point_id']
+      ) : SKIP
+      product_price_point_id = hash.key?('product_price_point_id') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoiceItemProductPricePointId), hash['product_price_point_id']
+      ) : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      CreateInvoiceItem.new(title,
+                            quantity,
+                            unit_price,
+                            taxable,
+                            tax_code,
+                            period_range_start,
+                            period_range_end,
+                            product_id,
+                            component_id,
+                            price_point_id,
+                            product_price_point_id,
+                            description)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateInvoiceItem | 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/create_invoice_payment.rb

@@ -0,0 +1,90 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateInvoicePayment Model.
+  class CreateInvoicePayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A string of the dollar amount to be refunded (eg. "10.50" => $10.50)
+    # @return [Object]
+    attr_accessor :amount
+
+    # A description to be attached to the payment.
+    # @return [String]
+    attr_accessor :memo
+
+    # The type of payment method used.
+    # @return [InvoicePaymentMethodType]
+    attr_accessor :method
+
+    # Additional information related to the payment method (eg. Check #)
+    # @return [String]
+    attr_accessor :details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['memo'] = 'memo'
+      @_hash['method'] = 'method'
+      @_hash['details'] = 'details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        memo
+        method
+        details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = SKIP, memo = SKIP,
+                   method = InvoicePaymentMethodType::OTHER, details = SKIP)
+      @amount = amount unless amount == SKIP
+      @memo = memo unless memo == SKIP
+      @method = method unless method == SKIP
+      @details = details unless details == 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.
+      amount = hash.key?('amount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateInvoicePaymentAmount), hash['amount']
+      ) : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      method = hash['method'] ||= InvoicePaymentMethodType::OTHER
+      details = hash.key?('details') ? hash['details'] : SKIP
+
+      # Create object from extracted values.
+      CreateInvoicePayment.new(amount,
+                               memo,
+                               method,
+                               details)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateInvoicePayment | 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/create_invoice_payment_application.rb

@@ -0,0 +1,79 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateInvoicePaymentApplication Model.
+  class CreateInvoicePaymentApplication < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the invoice. It has the prefix "inv_" followed by
+    # alphanumeric characters.
+    # @return [String]
+    attr_accessor :invoice_uid
+
+    # Dollar amount of the invoice payment (eg. "10.50" => $10.50).
+    # @return [String]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice_uid'] = 'invoice_uid'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(invoice_uid = nil, amount = nil)
+      @invoice_uid = invoice_uid
+      @amount = amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      invoice_uid = hash.key?('invoice_uid') ? hash['invoice_uid'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+
+      # Create object from extracted values.
+      CreateInvoicePaymentApplication.new(invoice_uid,
+                                          amount)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateInvoicePaymentApplication | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.invoice_uid,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['invoice_uid'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/create_invoice_payment_request.rb

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

data/lib/advanced_billing/models/create_invoice_request.rb

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