orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/product.rb

@@ -0,0 +1,123 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # Product Model.
+  class Product < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # 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['created_at'] = 'created_at'
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_at:, id:, name:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @created_at = created_at
+      @id = id
+      @name = name
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      id = hash.key?('id') ? hash['id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Product.new(created_at: created_at,
+                  id: id,
+                  name: name,
+                  additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Product | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.created_at,
+                                ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.name,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['created_at'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['name'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at}, id: #{@id}, name: #{@name},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at.inspect}, id: #{@id.inspect}, name:"\
+      " #{@name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/provider_type.rb

@@ -0,0 +1,36 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Provider Type.
+  class ProviderType
+    PROVIDER_TYPE = [
+      # TODO: Write general description for QUICKBOOKS
+      QUICKBOOKS = 'quickbooks'.freeze,
+
+      # TODO: Write general description for NETSUITE
+      NETSUITE = 'netsuite'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = QUICKBOOKS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'quickbooks' then QUICKBOOKS
+      when 'netsuite' then NETSUITE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/quantity_only_override_price.rb

@@ -0,0 +1,147 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # QuantityOnlyOverridePrice Model.
+  class QuantityOnlyOverridePrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # The subscription's override minimum amount for the plan.
+    # @return [String]
+    attr_accessor :minimum_amount
+
+    # The subscription's override maximum amount for the plan.
+    # @return [String]
+    attr_accessor :maximum_amount
+
+    # The currency of the price. If not provided, the currency of the plan will
+    # be used.
+    # @return [String]
+    attr_accessor :currency
+
+    # The per unit conversion rate of the price currency to the invoicing
+    # currency.
+    # @return [Float]
+    attr_accessor :conversion_rate
+
+    # The subscription's override discount for the plan.
+    # @return [DiscountOverride]
+    attr_accessor :discount
+
+    # The starting quantity of the price, if the price is a fixed price.
+    # @return [Float]
+    attr_accessor :fixed_price_quantity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['minimum_amount'] = 'minimum_amount'
+      @_hash['maximum_amount'] = 'maximum_amount'
+      @_hash['currency'] = 'currency'
+      @_hash['conversion_rate'] = 'conversion_rate'
+      @_hash['discount'] = 'discount'
+      @_hash['fixed_price_quantity'] = 'fixed_price_quantity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        minimum_amount
+        maximum_amount
+        currency
+        conversion_rate
+        discount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        minimum_amount
+        maximum_amount
+        currency
+        conversion_rate
+        discount
+      ]
+    end
+
+    def initialize(id:, fixed_price_quantity:, minimum_amount: SKIP,
+                   maximum_amount: SKIP, currency: SKIP, conversion_rate: SKIP,
+                   discount: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @minimum_amount = minimum_amount unless minimum_amount == SKIP
+      @maximum_amount = maximum_amount unless maximum_amount == SKIP
+      @currency = currency unless currency == SKIP
+      @conversion_rate = conversion_rate unless conversion_rate == SKIP
+      @discount = discount unless discount == SKIP
+      @fixed_price_quantity = fixed_price_quantity
+      @additional_properties = additional_properties
+    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'] : nil
+      fixed_price_quantity =
+        hash.key?('fixed_price_quantity') ? hash['fixed_price_quantity'] : nil
+      minimum_amount =
+        hash.key?('minimum_amount') ? hash['minimum_amount'] : SKIP
+      maximum_amount =
+        hash.key?('maximum_amount') ? hash['maximum_amount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      conversion_rate =
+        hash.key?('conversion_rate') ? hash['conversion_rate'] : SKIP
+      discount = DiscountOverride.from_hash(hash['discount']) if hash['discount']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      QuantityOnlyOverridePrice.new(id: id,
+                                    fixed_price_quantity: fixed_price_quantity,
+                                    minimum_amount: minimum_amount,
+                                    maximum_amount: maximum_amount,
+                                    currency: currency,
+                                    conversion_rate: conversion_rate,
+                                    discount: discount,
+                                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, minimum_amount: #{@minimum_amount}, maximum_amount:"\
+      " #{@maximum_amount}, currency: #{@currency}, conversion_rate: #{@conversion_rate},"\
+      " discount: #{@discount}, fixed_price_quantity: #{@fixed_price_quantity},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, minimum_amount: #{@minimum_amount.inspect},"\
+      " maximum_amount: #{@maximum_amount.inspect}, currency: #{@currency.inspect},"\
+      " conversion_rate: #{@conversion_rate.inspect}, discount: #{@discount.inspect},"\
+      " fixed_price_quantity: #{@fixed_price_quantity.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/reason.rb

@@ -0,0 +1,44 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Reason.
+  class Reason
+    REASON = [
+      # TODO: Write general description for DUPLICATE
+      DUPLICATE = 'Duplicate'.freeze,
+
+      # TODO: Write general description for FRAUDULENT
+      FRAUDULENT = 'Fraudulent'.freeze,
+
+      # TODO: Write general description for ENUM_ORDER_CHANGE
+      ENUM_ORDER_CHANGE = 'Order change'.freeze,
+
+      # TODO: Write general description for ENUM_PRODUCT_UNSATISFACTORY
+      ENUM_PRODUCT_UNSATISFACTORY = 'Product unsatisfactory'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DUPLICATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'duplicate' then DUPLICATE
+      when 'fraudulent' then FRAUDULENT
+      when 'enum_order_change' then ENUM_ORDER_CHANGE
+      when 'enum_product_unsatisfactory' then ENUM_PRODUCT_UNSATISFACTORY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/reason1.rb

@@ -0,0 +1,44 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # An optional reason for the credit note.
+  class Reason1
+    REASON1 = [
+      # TODO: Write general description for DUPLICATE
+      DUPLICATE = 'duplicate'.freeze,
+
+      # TODO: Write general description for FRAUDULENT
+      FRAUDULENT = 'fraudulent'.freeze,
+
+      # TODO: Write general description for ORDER_CHANGE
+      ORDER_CHANGE = 'order_change'.freeze,
+
+      # TODO: Write general description for PRODUCT_UNSATISFACTORY
+      PRODUCT_UNSATISFACTORY = 'product_unsatisfactory'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DUPLICATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'duplicate' then DUPLICATE
+      when 'fraudulent' then FRAUDULENT
+      when 'order_change' then ORDER_CHANGE
+      when 'product_unsatisfactory' then PRODUCT_UNSATISFACTORY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/redeem_coupon_params.rb

@@ -0,0 +1,126 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # RedeemCouponParams Model.
+  class RedeemCouponParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Coupon ID to be redeemed for this subscription.
+    # @return [String]
+    attr_accessor :coupon_id
+
+    # Redemption code of the coupon to be redeemed for this subscription.
+    # @return [String]
+    attr_accessor :coupon_redemption_code
+
+    # Redemption code of the coupon to be redeemed for this subscription.
+    # @return [ChangeOption1]
+    attr_accessor :change_option
+
+    # The date that the coupon discount should take effect. This parameter can
+    # only be passed if the `change_option` is `requested_date`.
+    # @return [DateTime]
+    attr_accessor :change_date
+
+    # If false, this request will fail if it would void an issued invoice or
+    # create a credit note. Consider using this as a safety mechanism if you do
+    # not expect existing invoices to be changed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_invoice_credit_or_void
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['coupon_id'] = 'coupon_id'
+      @_hash['coupon_redemption_code'] = 'coupon_redemption_code'
+      @_hash['change_option'] = 'change_option'
+      @_hash['change_date'] = 'change_date'
+      @_hash['allow_invoice_credit_or_void'] = 'allow_invoice_credit_or_void'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        coupon_id
+        coupon_redemption_code
+        change_date
+        allow_invoice_credit_or_void
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        coupon_id
+        coupon_redemption_code
+        change_date
+        allow_invoice_credit_or_void
+      ]
+    end
+
+    def initialize(change_option:, coupon_id: SKIP,
+                   coupon_redemption_code: SKIP, change_date: SKIP,
+                   allow_invoice_credit_or_void: true)
+      @coupon_id = coupon_id unless coupon_id == SKIP
+      @coupon_redemption_code = coupon_redemption_code unless coupon_redemption_code == SKIP
+      @change_option = change_option
+      @change_date = change_date unless change_date == SKIP
+      unless allow_invoice_credit_or_void == SKIP
+        @allow_invoice_credit_or_void =
+          allow_invoice_credit_or_void
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      change_option = hash.key?('change_option') ? hash['change_option'] : nil
+      coupon_id = hash.key?('coupon_id') ? hash['coupon_id'] : SKIP
+      coupon_redemption_code =
+        hash.key?('coupon_redemption_code') ? hash['coupon_redemption_code'] : SKIP
+      change_date = if hash.key?('change_date')
+                      (DateTimeHelper.from_rfc3339(hash['change_date']) if hash['change_date'])
+                    else
+                      SKIP
+                    end
+      allow_invoice_credit_or_void =
+        hash['allow_invoice_credit_or_void'] ||= true
+
+      # Create object from extracted values.
+      RedeemCouponParams.new(change_option: change_option,
+                             coupon_id: coupon_id,
+                             coupon_redemption_code: coupon_redemption_code,
+                             change_date: change_date,
+                             allow_invoice_credit_or_void: allow_invoice_credit_or_void)
+    end
+
+    def to_custom_change_date
+      DateTimeHelper.to_rfc3339(change_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} coupon_id: #{@coupon_id}, coupon_redemption_code:"\
+      " #{@coupon_redemption_code}, change_option: #{@change_option}, change_date:"\
+      " #{@change_date}, allow_invoice_credit_or_void: #{@allow_invoice_credit_or_void}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} coupon_id: #{@coupon_id.inspect}, coupon_redemption_code:"\
+      " #{@coupon_redemption_code.inspect}, change_option: #{@change_option.inspect}, change_date:"\
+      " #{@change_date.inspect}, allow_invoice_credit_or_void:"\
+      " #{@allow_invoice_credit_or_void.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/remove_plan_adjustment_params.rb

@@ -0,0 +1,74 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # RemovePlanAdjustmentParams Model.
+  class RemovePlanAdjustmentParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The id of the adjustment to remove from on the plan.
+    # @return [String]
+    attr_accessor :adjustment_id
+
+    # The phase to remove this adjustment from.
+    # @return [Integer]
+    attr_accessor :plan_phase_order
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['adjustment_id'] = 'adjustment_id'
+      @_hash['plan_phase_order'] = 'plan_phase_order'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        plan_phase_order
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        plan_phase_order
+      ]
+    end
+
+    def initialize(adjustment_id:, plan_phase_order: SKIP)
+      @adjustment_id = adjustment_id
+      @plan_phase_order = plan_phase_order unless plan_phase_order == 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.
+      adjustment_id = hash.key?('adjustment_id') ? hash['adjustment_id'] : nil
+      plan_phase_order =
+        hash.key?('plan_phase_order') ? hash['plan_phase_order'] : SKIP
+
+      # Create object from extracted values.
+      RemovePlanAdjustmentParams.new(adjustment_id: adjustment_id,
+                                     plan_phase_order: plan_phase_order)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} adjustment_id: #{@adjustment_id}, plan_phase_order: #{@plan_phase_order}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} adjustment_id: #{@adjustment_id.inspect}, plan_phase_order:"\
+      " #{@plan_phase_order.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/remove_plan_price_params.rb

@@ -0,0 +1,74 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # RemovePlanPriceParams Model.
+  class RemovePlanPriceParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The id of the price to remove from the plan.
+    # @return [String]
+    attr_accessor :price_id
+
+    # The phase to remove this price from.
+    # @return [Integer]
+    attr_accessor :plan_phase_order
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price_id'] = 'price_id'
+      @_hash['plan_phase_order'] = 'plan_phase_order'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        plan_phase_order
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        plan_phase_order
+      ]
+    end
+
+    def initialize(price_id:, plan_phase_order: SKIP)
+      @price_id = price_id
+      @plan_phase_order = plan_phase_order unless plan_phase_order == 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.
+      price_id = hash.key?('price_id') ? hash['price_id'] : nil
+      plan_phase_order =
+        hash.key?('plan_phase_order') ? hash['plan_phase_order'] : SKIP
+
+      # Create object from extracted values.
+      RemovePlanPriceParams.new(price_id: price_id,
+                                plan_phase_order: plan_phase_order)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price_id: #{@price_id}, plan_phase_order: #{@plan_phase_order}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price_id: #{@price_id.inspect}, plan_phase_order:"\
+      " #{@plan_phase_order.inspect}>"
+    end
+  end
+end