orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/country.rb

@@ -0,0 +1,492 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Country.
+  class Country
+    COUNTRY = [
+      # TODO: Write general description for AD
+      AD = 'AD'.freeze,
+
+      # TODO: Write general description for AE
+      AE = 'AE'.freeze,
+
+      # TODO: Write general description for AL
+      AL = 'AL'.freeze,
+
+      # TODO: Write general description for AM
+      AM = 'AM'.freeze,
+
+      # TODO: Write general description for AO
+      AO = 'AO'.freeze,
+
+      # TODO: Write general description for AR
+      AR = 'AR'.freeze,
+
+      # TODO: Write general description for AT
+      AT = 'AT'.freeze,
+
+      # TODO: Write general description for AU
+      AU = 'AU'.freeze,
+
+      # TODO: Write general description for AW
+      AW = 'AW'.freeze,
+
+      # TODO: Write general description for AZ
+      AZ = 'AZ'.freeze,
+
+      # TODO: Write general description for BA
+      BA = 'BA'.freeze,
+
+      # TODO: Write general description for BB
+      BB = 'BB'.freeze,
+
+      # TODO: Write general description for BD
+      BD = 'BD'.freeze,
+
+      # TODO: Write general description for BE
+      BE = 'BE'.freeze,
+
+      # TODO: Write general description for BF
+      BF = 'BF'.freeze,
+
+      # TODO: Write general description for BG
+      BG = 'BG'.freeze,
+
+      # TODO: Write general description for BH
+      BH = 'BH'.freeze,
+
+      # TODO: Write general description for BJ
+      BJ = 'BJ'.freeze,
+
+      # TODO: Write general description for BO
+      BO = 'BO'.freeze,
+
+      # TODO: Write general description for BR
+      BR = 'BR'.freeze,
+
+      # TODO: Write general description for BS
+      BS = 'BS'.freeze,
+
+      # TODO: Write general description for BY
+      BY = 'BY'.freeze,
+
+      # TODO: Write general description for CA
+      CA = 'CA'.freeze,
+
+      # TODO: Write general description for CD
+      CD = 'CD'.freeze,
+
+      # TODO: Write general description for CH
+      CH = 'CH'.freeze,
+
+      # TODO: Write general description for CL
+      CL = 'CL'.freeze,
+
+      # TODO: Write general description for CM
+      CM = 'CM'.freeze,
+
+      # TODO: Write general description for CN
+      CN = 'CN'.freeze,
+
+      # TODO: Write general description for CO
+      CO = 'CO'.freeze,
+
+      # TODO: Write general description for CR
+      CR = 'CR'.freeze,
+
+      # TODO: Write general description for CV
+      CV = 'CV'.freeze,
+
+      # TODO: Write general description for CY
+      CY = 'CY'.freeze,
+
+      # TODO: Write general description for CZ
+      CZ = 'CZ'.freeze,
+
+      # TODO: Write general description for DE
+      DE = 'DE'.freeze,
+
+      # TODO: Write general description for DK
+      DK = 'DK'.freeze,
+
+      # TODO: Write general description for DO
+      DO = 'DO'.freeze,
+
+      # TODO: Write general description for EC
+      EC = 'EC'.freeze,
+
+      # TODO: Write general description for EE
+      EE = 'EE'.freeze,
+
+      # TODO: Write general description for EG
+      EG = 'EG'.freeze,
+
+      # TODO: Write general description for ES
+      ES = 'ES'.freeze,
+
+      # TODO: Write general description for ET
+      ET = 'ET'.freeze,
+
+      # TODO: Write general description for EU
+      EU = 'EU'.freeze,
+
+      # TODO: Write general description for FI
+      FI = 'FI'.freeze,
+
+      # TODO: Write general description for FO
+      FO = 'FO'.freeze,
+
+      # TODO: Write general description for FR
+      FR = 'FR'.freeze,
+
+      # TODO: Write general description for GB
+      GB = 'GB'.freeze,
+
+      # TODO: Write general description for GE
+      GE = 'GE'.freeze,
+
+      # TODO: Write general description for GI
+      GI = 'GI'.freeze,
+
+      # TODO: Write general description for GN
+      GN = 'GN'.freeze,
+
+      # TODO: Write general description for GR
+      GR = 'GR'.freeze,
+
+      # TODO: Write general description for HK
+      HK = 'HK'.freeze,
+
+      # TODO: Write general description for HR
+      HR = 'HR'.freeze,
+
+      # TODO: Write general description for HU
+      HU = 'HU'.freeze,
+
+      # TODO: Write general description for ID
+      ID = 'ID'.freeze,
+
+      # TODO: Write general description for IE
+      IE = 'IE'.freeze,
+
+      # TODO: Write general description for IL
+      IL = 'IL'.freeze,
+
+      # TODO: Write general description for IN
+      IN = 'IN'.freeze,
+
+      # TODO: Write general description for IS
+      IS = 'IS'.freeze,
+
+      # TODO: Write general description for IT
+      IT = 'IT'.freeze,
+
+      # TODO: Write general description for JP
+      JP = 'JP'.freeze,
+
+      # TODO: Write general description for KE
+      KE = 'KE'.freeze,
+
+      # TODO: Write general description for KG
+      KG = 'KG'.freeze,
+
+      # TODO: Write general description for KH
+      KH = 'KH'.freeze,
+
+      # TODO: Write general description for KR
+      KR = 'KR'.freeze,
+
+      # TODO: Write general description for KZ
+      KZ = 'KZ'.freeze,
+
+      # TODO: Write general description for LA
+      LA = 'LA'.freeze,
+
+      # TODO: Write general description for LI
+      LI = 'LI'.freeze,
+
+      # TODO: Write general description for LK
+      LK = 'LK'.freeze,
+
+      # TODO: Write general description for LT
+      LT = 'LT'.freeze,
+
+      # TODO: Write general description for LU
+      LU = 'LU'.freeze,
+
+      # TODO: Write general description for LV
+      LV = 'LV'.freeze,
+
+      # TODO: Write general description for MA
+      MA = 'MA'.freeze,
+
+      # TODO: Write general description for MD
+      MD = 'MD'.freeze,
+
+      # TODO: Write general description for ME
+      ME = 'ME'.freeze,
+
+      # TODO: Write general description for MK
+      MK = 'MK'.freeze,
+
+      # TODO: Write general description for MR
+      MR = 'MR'.freeze,
+
+      # TODO: Write general description for MT
+      MT = 'MT'.freeze,
+
+      # TODO: Write general description for MX
+      MX = 'MX'.freeze,
+
+      # TODO: Write general description for MY
+      MY = 'MY'.freeze,
+
+      # TODO: Write general description for NG
+      NG = 'NG'.freeze,
+
+      # TODO: Write general description for NL
+      NL = 'NL'.freeze,
+
+      # TODO: Write general description for NO
+      NO = 'NO'.freeze,
+
+      # TODO: Write general description for NP
+      NP = 'NP'.freeze,
+
+      # TODO: Write general description for NZ
+      NZ = 'NZ'.freeze,
+
+      # TODO: Write general description for OM
+      OM = 'OM'.freeze,
+
+      # TODO: Write general description for PE
+      PE = 'PE'.freeze,
+
+      # TODO: Write general description for PH
+      PH = 'PH'.freeze,
+
+      # TODO: Write general description for PL
+      PL = 'PL'.freeze,
+
+      # TODO: Write general description for PT
+      PT = 'PT'.freeze,
+
+      # TODO: Write general description for PY
+      PY = 'PY'.freeze,
+
+      # TODO: Write general description for RO
+      RO = 'RO'.freeze,
+
+      # TODO: Write general description for RS
+      RS = 'RS'.freeze,
+
+      # TODO: Write general description for RU
+      RU = 'RU'.freeze,
+
+      # TODO: Write general description for SA
+      SA = 'SA'.freeze,
+
+      # TODO: Write general description for SE
+      SE = 'SE'.freeze,
+
+      # TODO: Write general description for SG
+      SG = 'SG'.freeze,
+
+      # TODO: Write general description for SI
+      SI = 'SI'.freeze,
+
+      # TODO: Write general description for SK
+      SK = 'SK'.freeze,
+
+      # TODO: Write general description for SN
+      SN = 'SN'.freeze,
+
+      # TODO: Write general description for SR
+      SR = 'SR'.freeze,
+
+      # TODO: Write general description for SV
+      SV = 'SV'.freeze,
+
+      # TODO: Write general description for TH
+      TH = 'TH'.freeze,
+
+      # TODO: Write general description for TJ
+      TJ = 'TJ'.freeze,
+
+      # TODO: Write general description for TR
+      TR = 'TR'.freeze,
+
+      # TODO: Write general description for TW
+      TW = 'TW'.freeze,
+
+      # TODO: Write general description for TZ
+      TZ = 'TZ'.freeze,
+
+      # TODO: Write general description for UA
+      UA = 'UA'.freeze,
+
+      # TODO: Write general description for UG
+      UG = 'UG'.freeze,
+
+      # TODO: Write general description for US
+      US = 'US'.freeze,
+
+      # TODO: Write general description for UY
+      UY = 'UY'.freeze,
+
+      # TODO: Write general description for UZ
+      UZ = 'UZ'.freeze,
+
+      # TODO: Write general description for VE
+      VE = 'VE'.freeze,
+
+      # TODO: Write general description for VN
+      VN = 'VN'.freeze,
+
+      # TODO: Write general description for ZA
+      ZA = 'ZA'.freeze,
+
+      # TODO: Write general description for ZM
+      ZM = 'ZM'.freeze,
+
+      # TODO: Write general description for ZW
+      ZW = 'ZW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = AD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'ad' then AD
+      when 'ae' then AE
+      when 'al' then AL
+      when 'am' then AM
+      when 'ao' then AO
+      when 'ar' then AR
+      when 'at' then AT
+      when 'au' then AU
+      when 'aw' then AW
+      when 'az' then AZ
+      when 'ba' then BA
+      when 'bb' then BB
+      when 'bd' then BD
+      when 'be' then BE
+      when 'bf' then BF
+      when 'bg' then BG
+      when 'bh' then BH
+      when 'bj' then BJ
+      when 'bo' then BO
+      when 'br' then BR
+      when 'bs' then BS
+      when 'by' then BY
+      when 'ca' then CA
+      when 'cd' then CD
+      when 'ch' then CH
+      when 'cl' then CL
+      when 'cm' then CM
+      when 'cn' then CN
+      when 'co' then CO
+      when 'cr' then CR
+      when 'cv' then CV
+      when 'cy' then CY
+      when 'cz' then CZ
+      when 'de' then DE
+      when 'dk' then DK
+      when 'do' then DO
+      when 'ec' then EC
+      when 'ee' then EE
+      when 'eg' then EG
+      when 'es' then ES
+      when 'et' then ET
+      when 'eu' then EU
+      when 'fi' then FI
+      when 'fo' then FO
+      when 'fr' then FR
+      when 'gb' then GB
+      when 'ge' then GE
+      when 'gi' then GI
+      when 'gn' then GN
+      when 'gr' then GR
+      when 'hk' then HK
+      when 'hr' then HR
+      when 'hu' then HU
+      when 'id' then ID
+      when 'ie' then IE
+      when 'il' then IL
+      when 'in' then IN
+      when 'is' then IS
+      when 'it' then IT
+      when 'jp' then JP
+      when 'ke' then KE
+      when 'kg' then KG
+      when 'kh' then KH
+      when 'kr' then KR
+      when 'kz' then KZ
+      when 'la' then LA
+      when 'li' then LI
+      when 'lk' then LK
+      when 'lt' then LT
+      when 'lu' then LU
+      when 'lv' then LV
+      when 'ma' then MA
+      when 'md' then MD
+      when 'me' then ME
+      when 'mk' then MK
+      when 'mr' then MR
+      when 'mt' then MT
+      when 'mx' then MX
+      when 'my' then MY
+      when 'ng' then NG
+      when 'nl' then NL
+      when 'no' then NO
+      when 'np' then NP
+      when 'nz' then NZ
+      when 'om' then OM
+      when 'pe' then PE
+      when 'ph' then PH
+      when 'pl' then PL
+      when 'pt' then PT
+      when 'py' then PY
+      when 'ro' then RO
+      when 'rs' then RS
+      when 'ru' then RU
+      when 'sa' then SA
+      when 'se' then SE
+      when 'sg' then SG
+      when 'si' then SI
+      when 'sk' then SK
+      when 'sn' then SN
+      when 'sr' then SR
+      when 'sv' then SV
+      when 'th' then TH
+      when 'tj' then TJ
+      when 'tr' then TR
+      when 'tw' then TW
+      when 'tz' then TZ
+      when 'ua' then UA
+      when 'ug' then UG
+      when 'us' then US
+      when 'uy' then UY
+      when 'uz' then UZ
+      when 've' then VE
+      when 'vn' then VN
+      when 'za' then ZA
+      when 'zm' then ZM
+      when 'zw' then ZW
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/coupon.rb

@@ -0,0 +1,195 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # A coupon represents a reusable discount configuration that can be applied
+  # either as a fixed or percentage amount to an invoice or subscription.
+  # Coupons are activated using a redemption code, which applies the discount to
+  # a subscription or invoice. The duration of a coupon determines how long it
+  # remains available for use by end users.
+  class Coupon < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Also referred to as coupon_id in this documentation.
+    # @return [String]
+    attr_accessor :id
+
+    # This string can be used to redeem this coupon for a given subscription.
+    # @return [String]
+    attr_accessor :redemption_code
+
+    # This string can be used to redeem this coupon for a given subscription.
+    # @return [Object]
+    attr_accessor :discount
+
+    # The number of times this coupon has been redeemed.
+    # @return [Integer]
+    attr_accessor :times_redeemed
+
+    # This allows for a coupon's discount to apply for a limited time
+    # (determined in months); a `null` value here means "unlimited time".
+    # @return [Integer]
+    attr_accessor :duration_in_months
+
+    # The maximum number of redemptions allowed for this coupon before it is
+    # exhausted; `null` here means "unlimited".
+    # @return [Integer]
+    attr_accessor :max_redemptions
+
+    # An archived coupon can no longer be redeemed. Active coupons will have a
+    # value of null for `archived_at`; this field will be non-null for archived
+    # coupons.
+    # @return [DateTime]
+    attr_accessor :archived_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['redemption_code'] = 'redemption_code'
+      @_hash['discount'] = 'discount'
+      @_hash['times_redeemed'] = 'times_redeemed'
+      @_hash['duration_in_months'] = 'duration_in_months'
+      @_hash['max_redemptions'] = 'max_redemptions'
+      @_hash['archived_at'] = 'archived_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        duration_in_months
+        max_redemptions
+        archived_at
+      ]
+    end
+
+    def initialize(id:, redemption_code:, discount:, times_redeemed:,
+                   duration_in_months:, max_redemptions:, archived_at:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @redemption_code = redemption_code
+      @discount = discount
+      @times_redeemed = times_redeemed
+      @duration_in_months = duration_in_months
+      @max_redemptions = max_redemptions
+      @archived_at = archived_at
+      @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
+      redemption_code =
+        hash.key?('redemption_code') ? hash['redemption_code'] : nil
+      discount = hash.key?('discount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CouponDiscount), hash['discount']
+      ) : nil
+      times_redeemed =
+        hash.key?('times_redeemed') ? hash['times_redeemed'] : nil
+      duration_in_months =
+        hash.key?('duration_in_months') ? hash['duration_in_months'] : nil
+      max_redemptions =
+        hash.key?('max_redemptions') ? hash['max_redemptions'] : nil
+      archived_at = if hash.key?('archived_at')
+                      (DateTimeHelper.from_rfc3339(hash['archived_at']) if hash['archived_at'])
+                    end
+
+      # 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.
+      Coupon.new(id: id,
+                 redemption_code: redemption_code,
+                 discount: discount,
+                 times_redeemed: times_redeemed,
+                 duration_in_months: duration_in_months,
+                 max_redemptions: max_redemptions,
+                 archived_at: archived_at,
+                 additional_properties: additional_properties)
+    end
+
+    def to_custom_archived_at
+      DateTimeHelper.to_rfc3339(archived_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Coupon | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.redemption_code,
+                                  ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:CouponDiscount)
+                           .validate(value.discount) and
+            APIHelper.valid_type?(value.times_redeemed,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.duration_in_months,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.max_redemptions,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.archived_at,
+                                  ->(val) { val.instance_of? DateTime })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['redemption_code'],
+                                ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:CouponDiscount)
+                         .validate(value['discount']) and
+          APIHelper.valid_type?(value['times_redeemed'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['duration_in_months'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['max_redemptions'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['archived_at'],
+                                ->(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} id: #{@id}, redemption_code: #{@redemption_code}, discount: #{@discount},"\
+      " times_redeemed: #{@times_redeemed}, duration_in_months: #{@duration_in_months},"\
+      " max_redemptions: #{@max_redemptions}, archived_at: #{@archived_at}, 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}, redemption_code: #{@redemption_code.inspect}, discount:"\
+      " #{@discount.inspect}, times_redeemed: #{@times_redeemed.inspect}, duration_in_months:"\
+      " #{@duration_in_months.inspect}, max_redemptions: #{@max_redemptions.inspect}, archived_at:"\
+      " #{@archived_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end