lob 5.1.2 → 6.0.2

data/lib/openapi_client/models/country_extended_expanded.rb

@@ -0,0 +1,255 @@
+=begin
+#Lob
+
+#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? 
+
+The version of the OpenAPI document: 1.3.0
+Contact: lob-openapi@lob.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Lob
+  class CountryExtendedExpanded
+    EMPTY = "".freeze
+    AFGHANISTAN = "AFGHANISTAN".freeze
+    ALBANIA = "ALBANIA".freeze
+    ALGERIA = "ALGERIA".freeze
+    AMERICAN_SAMOA = "AMERICAN SAMOA".freeze
+    ANDORRA = "ANDORRA".freeze
+    ANGOLA = "ANGOLA".freeze
+    ANGUILLA = "ANGUILLA".freeze
+    ANTARCTICA = "ANTARCTICA".freeze
+    ANTIGUA_AND_BARBUDA = "ANTIGUA AND BARBUDA".freeze
+    ARGENTINA = "ARGENTINA".freeze
+    ARUBA = "ARUBA".freeze
+    AUSTRALIA = "AUSTRALIA".freeze
+    AUSTRIA = "AUSTRIA".freeze
+    AZERBAIJAN = "AZERBAIJAN".freeze
+    BAHRAIN = "BAHRAIN".freeze
+    BANGLADESH = "BANGLADESH".freeze
+    BARBADOS = "BARBADOS".freeze
+    BELARUS = "BELARUS".freeze
+    BELGIUM = "BELGIUM".freeze
+    BELIZE = "BELIZE".freeze
+    BENIN = "BENIN".freeze
+    BERMUDA = "BERMUDA".freeze
+    BHUTAN = "BHUTAN".freeze
+    BOLIVIA__PLURINATIONAL_STATE_OF = "BOLIVIA (PLURINATIONAL STATE OF)".freeze
+    BONAIRE_SAINT_EUSTATIUS_AND_SABA = "BONAIRE, SAINT EUSTATIUS AND SABA".freeze
+    BOSNIA_AND_HERZEGOVINA = "BOSNIA AND HERZEGOVINA".freeze
+    BOTSWANA = "BOTSWANA".freeze
+    BRAZIL = "BRAZIL".freeze
+    BRITISH_INDIAN_OCEAN_TERRITORY = "BRITISH INDIAN OCEAN TERRITORY".freeze
+    BRITISH_VIRGIN_ISLANDS = "BRITISH VIRGIN ISLANDS".freeze
+    BRUNEI_DARUSSALAM = "BRUNEI DARUSSALAM".freeze
+    BULGARIA = "BULGARIA".freeze
+    BURKINA_FASO = "BURKINA FASO".freeze
+    BURUNDI = "BURUNDI".freeze
+    CABO_VERDE = "CABO VERDE".freeze
+    CAMBODIA = "CAMBODIA".freeze
+    CAMEROON = "CAMEROON".freeze
+    CANADA = "CANADA".freeze
+    CAYMAN_ISLANDS = "CAYMAN ISLANDS".freeze
+    CENTRAL_AFRICAN_REPUBLIC = "CENTRAL AFRICAN REPUBLIC".freeze
+    CHAD = "CHAD".freeze
+    CHILE = "CHILE".freeze
+    CHINA = "CHINA".freeze
+    COLOMBIA = "COLOMBIA".freeze
+    COMOROS = "COMOROS".freeze
+    CONGO = "CONGO".freeze
+    CONGO_DEMOCRATIC_REPUBLIC_OF_THE = "CONGO, DEMOCRATIC REPUBLIC OF THE".freeze
+    COOK_ISLANDS = "COOK ISLANDS".freeze
+    COSTA_RICA = "COSTA RICA".freeze
+    CTE_DIVOIRE = "CÔTE D`IVOIRE".freeze
+    CROATIA = "CROATIA".freeze
+    CUBA = "CUBA".freeze
+    CURAAO = "CURAÇAO".freeze
+    CYPRUS = "CYPRUS".freeze
+    CZECH_REPUBLIC = "CZECH REPUBLIC".freeze
+    DENMARK = "DENMARK".freeze
+    DJIBOUTI = "DJIBOUTI".freeze
+    DOMINICA = "DOMINICA".freeze
+    DOMINICAN_REPUBLIC = "DOMINICAN REPUBLIC".freeze
+    ECUADOR = "ECUADOR".freeze
+    EGYPT = "EGYPT".freeze
+    EL_SALVADOR = "EL SALVADOR".freeze
+    EQUATORIAL_GUINEA = "EQUATORIAL GUINEA".freeze
+    ERITREA = "ERITREA".freeze
+    ESTONIA = "ESTONIA".freeze
+    ESWATINI = "ESWATINI".freeze
+    ETHIOPIA = "ETHIOPIA".freeze
+    FALKLAND_ISLANDS__MALVINAS = "FALKLAND ISLANDS (MALVINAS)".freeze
+    FAROE_ISLANDS = "FAROE ISLANDS".freeze
+    FIJI = "FIJI".freeze
+    FINLAND = "FINLAND".freeze
+    FRANCE = "FRANCE".freeze
+    GABON = "GABON".freeze
+    GAMBIA = "GAMBIA".freeze
+    GEORGIA = "GEORGIA".freeze
+    GERMANY = "GERMANY".freeze
+    GHANA = "GHANA".freeze
+    GIBRALTAR = "GIBRALTAR".freeze
+    GREECE = "GREECE".freeze
+    GREENLAND = "GREENLAND".freeze
+    GRENADA = "GRENADA".freeze
+    GUATEMALA = "GUATEMALA".freeze
+    GUINEA = "GUINEA".freeze
+    GUINEA_BISSAU = "GUINEA-BISSAU".freeze
+    GUYANA = "GUYANA".freeze
+    HAITI = "HAITI".freeze
+    HOLY_SEE = "HOLY SEE".freeze
+    HONDURAS = "HONDURAS".freeze
+    HONG_KONG = "HONG KONG".freeze
+    HUNGARY = "HUNGARY".freeze
+    ICELAND = "ICELAND".freeze
+    INDIA = "INDIA".freeze
+    INDONESIA = "INDONESIA".freeze
+    IRAN__ISLAMIC_REPUBLIC_OF = "IRAN (ISLAMIC REPUBLIC OF)".freeze
+    IRAQ = "IRAQ".freeze
+    IRELAND = "IRELAND".freeze
+    ISRAEL = "ISRAEL".freeze
+    ITALY = "ITALY".freeze
+    JAMAICA = "JAMAICA".freeze
+    JAPAN = "JAPAN".freeze
+    JORDAN = "JORDAN".freeze
+    KAZAKHSTAN = "KAZAKHSTAN".freeze
+    KENYA = "KENYA".freeze
+    KIRIBATI = "KIRIBATI".freeze
+    KOREA__DEMOCRATIC_PEOPLES_REPUBLIC_OF = "KOREA (DEMOCRATIC PEOPLE’S REPUBLIC OF)".freeze
+    KOREA_REPUBLIC_OF = "KOREA, REPUBLIC OF".freeze
+    KUWAIT = "KUWAIT".freeze
+    KYRGYZSTAN = "KYRGYZSTAN".freeze
+    LAO_PEOPLES_DEMOCRATIC_REPUBLIC = "LAO PEOPLE’S DEMOCRATIC REPUBLIC".freeze
+    LATVIA = "LATVIA".freeze
+    LEBANON = "LEBANON".freeze
+    LESOTHO = "LESOTHO".freeze
+    LIBERIA = "LIBERIA".freeze
+    LIBYA = "LIBYA".freeze
+    LIECHTENSTEIN = "LIECHTENSTEIN".freeze
+    LITHUANIA = "LITHUANIA".freeze
+    LUXEMBOURG = "LUXEMBOURG".freeze
+    MACAO = "MACAO".freeze
+    MACEDONIA = "MACEDONIA".freeze
+    MADAGASCAR = "MADAGASCAR".freeze
+    MALAWI = "MALAWI".freeze
+    MALAYSIA = "MALAYSIA".freeze
+    MALDIVES = "MALDIVES".freeze
+    MALI = "MALI".freeze
+    MALTA = "MALTA".freeze
+    MAURITANIA = "MAURITANIA".freeze
+    MAURITIUS = "MAURITIUS".freeze
+    MEXICO = "MEXICO".freeze
+    MOLDOVA_REPUBLIC_OF = "MOLDOVA, REPUBLIC OF".freeze
+    MONACO = "MONACO".freeze
+    MONGOLIA = "MONGOLIA".freeze
+    MONTENEGRO = "MONTENEGRO".freeze
+    MONTSERRAT = "MONTSERRAT".freeze
+    MOROCCO = "MOROCCO".freeze
+    MOZAMBIQUE = "MOZAMBIQUE".freeze
+    MYANMAR = "MYANMAR".freeze
+    NAMIBIA = "NAMIBIA".freeze
+    NAURU = "NAURU".freeze
+    NEPAL = "NEPAL".freeze
+    NETHERLAND_ANTILLES = "NETHERLAND ANTILLES".freeze
+    NETHERLANDS = "NETHERLANDS".freeze
+    NEW_ZEALAND = "NEW ZEALAND".freeze
+    NICARAGUA = "NICARAGUA".freeze
+    NIGER = "NIGER".freeze
+    NIGERIA = "NIGERIA".freeze
+    NIUE = "NIUE".freeze
+    NORFOLK_ISLAND = "NORFOLK ISLAND".freeze
+    NORWAY = "NORWAY".freeze
+    OMAN = "OMAN".freeze
+    PAKISTAN = "PAKISTAN".freeze
+    PANAMA = "PANAMA".freeze
+    PAPUA_NEW_GUINEA = "PAPUA NEW GUINEA".freeze
+    PARAGUAY = "PARAGUAY".freeze
+    PERU = "PERU".freeze
+    PHILIPPINES = "PHILIPPINES".freeze
+    PITCAIRN = "PITCAIRN".freeze
+    POLAND = "POLAND".freeze
+    PORTUGAL = "PORTUGAL".freeze
+    QATAR = "QATAR".freeze
+    ROMANIA = "ROMANIA".freeze
+    RUSSIAN_FEDERATION = "RUSSIAN FEDERATION".freeze
+    RWANDA = "RWANDA".freeze
+    SAINT_HELENA = "SAINT HELENA".freeze
+    SAINT_KITTS_AND_NEVIS = "SAINT KITTS AND NEVIS".freeze
+    SAINT_LUCIA = "SAINT LUCIA".freeze
+    SAINT_VINCENT_AND_THE_GRENADINES = "SAINT VINCENT AND THE GRENADINES".freeze
+    SAMOA = "SAMOA".freeze
+    SAN_MARINO = "SAN MARINO".freeze
+    SAO_TOME_AND_PRINCIPE = "SAO TOME AND PRINCIPE".freeze
+    SAUDI_ARABIA = "SAUDI ARABIA".freeze
+    SENEGAL = "SENEGAL".freeze
+    SERBIA = "SERBIA".freeze
+    SEYCHELLES = "SEYCHELLES".freeze
+    SIERRA_LEONE = "SIERRA LEONE".freeze
+    SINGAPORE = "SINGAPORE".freeze
+    SINT_MAARTEN = "SINT MAARTEN".freeze
+    SLOVAKIA = "SLOVAKIA".freeze
+    SLOVENIA = "SLOVENIA".freeze
+    SOLOMON_ISLANDS = "SOLOMON ISLANDS".freeze
+    SOMALIA = "SOMALIA".freeze
+    SOUTH_AFRICA = "SOUTH AFRICA".freeze
+    SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS = "SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS".freeze
+    SOUTH_SUDAN = "SOUTH SUDAN".freeze
+    SPAIN = "SPAIN".freeze
+    SRI_LANKA = "SRI LANKA".freeze
+    SUDAN = "SUDAN".freeze
+    SURINAME = "SURINAME".freeze
+    SWEDEN = "SWEDEN".freeze
+    SWITZERLAND = "SWITZERLAND".freeze
+    SYRIAN_ARAB_REPUBLIC = "SYRIAN ARAB REPUBLIC".freeze
+    TAIWAN = "TAIWAN".freeze
+    TAJIKISTAN = "TAJIKISTAN".freeze
+    TANZANIA = "TANZANIA".freeze
+    THAILAND = "THAILAND".freeze
+    THE_BAHAMAS = "THE BAHAMAS".freeze
+    TIMOR_LESTE = "TIMOR-LESTE".freeze
+    TOGO = "TOGO".freeze
+    TOKELAU = "TOKELAU".freeze
+    TONGA = "TONGA".freeze
+    TRINIDAD_AND_TOBAGO = "TRINIDAD AND TOBAGO".freeze
+    TUNISIA = "TUNISIA".freeze
+    TURKEY = "TURKEY".freeze
+    TURKMENISTAN = "TURKMENISTAN".freeze
+    TURKS_AND_CAICOS_ISLANDS = "TURKS AND CAICOS ISLANDS".freeze
+    TUVALU = "TUVALU".freeze
+    UGANDA = "UGANDA".freeze
+    UKRAINE = "UKRAINE".freeze
+    UNITED_ARAB_EMIRATES = "UNITED ARAB EMIRATES".freeze
+    UNITED_KINGDOM = "UNITED KINGDOM".freeze
+    UNITED_STATES = "UNITED STATES".freeze
+    URUGUAY = "URUGUAY".freeze
+    UZBEKISTAN = "UZBEKISTAN".freeze
+    VANUATU = "VANUATU".freeze
+    VENEZUELA = "VENEZUELA".freeze
+    VIET_NAM = "VIET NAM".freeze
+    WESTERN_SAHARA = "WESTERN SAHARA".freeze
+    YEMEN = "YEMEN".freeze
+    ZAMBIA = "ZAMBIA".freeze
+    ZIMBABWE = "ZIMBABWE".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = CountryExtendedExpanded.constants.select { |c| CountryExtendedExpanded::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #CountryExtendedExpanded" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/openapi_client/models/creative_patch.rb

@@ -0,0 +1,274 @@
+=begin
+#Lob
+
+#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? 
+
+The version of the OpenAPI document: 1.3.0
+Contact: lob-openapi@lob.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Lob
+  class CreativePatch
+    # Must either be an address ID or an inline object with correct address parameters.
+    attr_accessor :from
+
+    # An internal description that identifies this resource. Must be no longer than 255 characters. 
+    attr_accessor :description
+
+    # Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information.
+    attr_accessor :metadata
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'from' => :'from',
+        :'description' => :'description',
+        :'metadata' => :'metadata'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'from' => Array[:'AddressEditable', :'String'],
+        :'description' => :'String',
+        :'metadata' => :'Hash<String, String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'from',
+        :'description',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::CreativePatch` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::CreativePatch`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@description.nil? && @description.to_s.length > 255
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if !@description.nil? && @description.to_s.length > 255
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length > 255
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 255.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] metadata Value to be assigned
+    def metadata=(metadata)
+      @metadata = metadata
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          from == o.from &&
+          description == o.description &&
+          metadata == o.metadata
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [from, description, metadata].hash
+    end
+
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil) # // guardrails-disable-line
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) # // guardrails-disable-line
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil? && type.kind_of?(Array)
+          for base_type in type do
+            res = _deserialize(base_type, attributes[self.class.attribute_map[key]])
+            if !res.nil?
+              self.send("#{key}=", res) # // guardrails-disable-line
+              break
+            end
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) # // guardrails-disable-line
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Lob.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr) # // guardrails-disable-line
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end