lob 5.1.2 → 6.0.5

data/lib/openapi_client/models/zip_lookup_city.rb

@@ -0,0 +1,331 @@
+=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 ZipLookupCity
+    attr_accessor :city
+
+    # The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. 
+    attr_accessor :state
+
+    # County name of the address city.
+    attr_accessor :county
+
+    # A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code. 
+    attr_accessor :county_fips
+
+    # Indicates whether or not the city is the [USPS default city](https://en.wikipedia.org/wiki/ZIP_Code#ZIP_Codes_and_previous_zoning_lines) (preferred city) of a ZIP code. There is only one preferred city per ZIP code, which will always be in position 0 in the array of cities. 
+    attr_accessor :preferred
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'city' => :'city',
+        :'state' => :'state',
+        :'county' => :'county',
+        :'county_fips' => :'county_fips',
+        :'preferred' => :'preferred'
+      }
+    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
+      {
+        :'city' => :'String',
+        :'state' => :'String',
+        :'county' => :'String',
+        :'county_fips' => :'String',
+        :'preferred' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::ZipLookupCity` 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::ZipLookupCity`. 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?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'county')
+        self.county = attributes[:'county']
+      end
+
+      if attributes.key?(:'county_fips')
+        self.county_fips = attributes[:'county_fips']
+      end
+
+      if attributes.key?(:'preferred')
+        self.preferred = attributes[:'preferred']
+      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 @city.nil?
+        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      end
+
+      if @city.to_s.length > 200
+        invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 200.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @state.to_s.length > 2
+        invalid_properties.push('invalid value for "state", the character length must be smaller than or equal to 2.')
+      end
+
+      if @county.nil?
+        invalid_properties.push('invalid value for "county", county cannot be nil.')
+      end
+
+      if @county_fips.nil?
+        invalid_properties.push('invalid value for "county_fips", county_fips cannot be nil.')
+      end
+
+      if @preferred.nil?
+        invalid_properties.push('invalid value for "preferred", preferred cannot be nil.')
+      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 @city.nil?
+      return false if @city.to_s.length > 200
+      return false if @state.nil?
+      return false if @state.to_s.length > 2
+      return false if @county.nil?
+      return false if @county_fips.nil?
+      return false if @preferred.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if city.nil?
+        fail ArgumentError, 'city cannot be nil'
+      end
+
+      if city.to_s.length > 200
+        fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 200.'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if state.nil?
+        fail ArgumentError, 'state cannot be nil'
+      end
+
+      if state.to_s.length > 2
+        fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 2.'
+      end
+
+      @state = state
+    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 &&
+          city == o.city &&
+          state == o.state &&
+          county == o.county &&
+          county_fips == o.county_fips &&
+          preferred == o.preferred
+    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
+      [city, state, county, county_fips, preferred].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

data/lib/openapi_client/version.rb

@@ -0,0 +1,15 @@
+=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
+
+module Lob
+  VERSION = '6.0.5'
+end

data/lib/openapi_client.rb

@@ -0,0 +1,212 @@
+=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
+
+# Common files
+require 'openapi_client/api_client'
+require 'openapi_client/api_error'
+require 'openapi_client/version'
+require 'openapi_client/configuration'
+
+# Models
+require 'openapi_client/models/address'
+require 'openapi_client/models/address_deletion'
+require 'openapi_client/models/address_domestic'
+require 'openapi_client/models/address_domestic_expanded'
+require 'openapi_client/models/address_editable'
+require 'openapi_client/models/address_list'
+require 'openapi_client/models/bank_account'
+require 'openapi_client/models/bank_account_deletion'
+require 'openapi_client/models/bank_account_list'
+require 'openapi_client/models/bank_account_verify'
+require 'openapi_client/models/bank_account_writable'
+require 'openapi_client/models/bank_type_enum'
+require 'openapi_client/models/billing_group'
+require 'openapi_client/models/billing_group_editable'
+require 'openapi_client/models/billing_group_list'
+require 'openapi_client/models/buckslip'
+require 'openapi_client/models/buckslip_deletion'
+require 'openapi_client/models/buckslip_editable'
+require 'openapi_client/models/buckslip_order'
+require 'openapi_client/models/buckslip_order_editable'
+require 'openapi_client/models/buckslip_orders_list'
+require 'openapi_client/models/buckslip_updatable'
+require 'openapi_client/models/buckslips_list'
+require 'openapi_client/models/bulk_error'
+require 'openapi_client/models/bulk_error_properties'
+require 'openapi_client/models/campaign'
+require 'openapi_client/models/campaign_creative'
+require 'openapi_client/models/campaign_deletion'
+require 'openapi_client/models/campaign_updatable'
+require 'openapi_client/models/campaign_writable'
+require 'openapi_client/models/campaigns_list'
+require 'openapi_client/models/card'
+require 'openapi_client/models/card_deletion'
+require 'openapi_client/models/card_editable'
+require 'openapi_client/models/card_list'
+require 'openapi_client/models/card_order'
+require 'openapi_client/models/card_order_editable'
+require 'openapi_client/models/card_order_list'
+require 'openapi_client/models/card_updatable'
+require 'openapi_client/models/check'
+require 'openapi_client/models/check_deletion'
+require 'openapi_client/models/check_editable'
+require 'openapi_client/models/check_list'
+require 'openapi_client/models/chk_use_type'
+require 'openapi_client/models/cmp_schedule_type'
+require 'openapi_client/models/cmp_use_type'
+require 'openapi_client/models/country_extended'
+require 'openapi_client/models/country_extended_expanded'
+require 'openapi_client/models/creative_patch'
+require 'openapi_client/models/creative_response'
+require 'openapi_client/models/creative_writable'
+require 'openapi_client/models/custom_envelope_returned'
+require 'openapi_client/models/deliverability_analysis'
+require 'openapi_client/models/dpv_footnote'
+require 'openapi_client/models/engine_html'
+require 'openapi_client/models/event_type'
+require 'openapi_client/models/events'
+require 'openapi_client/models/export'
+require 'openapi_client/models/export_model'
+require 'openapi_client/models/geocode_addresses'
+require 'openapi_client/models/geocode_components'
+require 'openapi_client/models/http_validation_error'
+require 'openapi_client/models/identity_validation'
+require 'openapi_client/models/inline_object'
+require 'openapi_client/models/intl_autocompletions'
+require 'openapi_client/models/intl_autocompletions_writable'
+require 'openapi_client/models/intl_components'
+require 'openapi_client/models/intl_suggestions'
+require 'openapi_client/models/intl_verification'
+require 'openapi_client/models/intl_verification_or_error'
+require 'openapi_client/models/intl_verification_writable'
+require 'openapi_client/models/intl_verifications'
+require 'openapi_client/models/intl_verifications_payload'
+require 'openapi_client/models/letter'
+require 'openapi_client/models/letter_custom_envelope'
+require 'openapi_client/models/letter_deletion'
+require 'openapi_client/models/letter_details_returned'
+require 'openapi_client/models/letter_details_writable'
+require 'openapi_client/models/letter_editable'
+require 'openapi_client/models/letter_list'
+require 'openapi_client/models/lob_confidence_score'
+require 'openapi_client/models/lob_error'
+require 'openapi_client/models/location'
+require 'openapi_client/models/location_analysis'
+require 'openapi_client/models/ltr_use_type'
+require 'openapi_client/models/mail_type'
+require 'openapi_client/models/multi_line_address'
+require 'openapi_client/models/multiple_components'
+require 'openapi_client/models/multiple_components_intl'
+require 'openapi_client/models/multiple_components_list'
+require 'openapi_client/models/optional_address_column_mapping'
+require 'openapi_client/models/placeholder_model'
+require 'openapi_client/models/postcard'
+require 'openapi_client/models/postcard_deletion'
+require 'openapi_client/models/postcard_details_returned'
+require 'openapi_client/models/postcard_details_writable'
+require 'openapi_client/models/postcard_editable'
+require 'openapi_client/models/postcard_list'
+require 'openapi_client/models/postcard_size'
+require 'openapi_client/models/psc_use_type'
+require 'openapi_client/models/qr_code'
+require 'openapi_client/models/required_address_column_mapping'
+require 'openapi_client/models/return_envelope'
+require 'openapi_client/models/reverse_geocode'
+require 'openapi_client/models/self_mailer'
+require 'openapi_client/models/self_mailer_deletion'
+require 'openapi_client/models/self_mailer_editable'
+require 'openapi_client/models/self_mailer_list'
+require 'openapi_client/models/self_mailer_size'
+require 'openapi_client/models/sfm_use_type'
+require 'openapi_client/models/sort_by'
+require 'openapi_client/models/sort_by1'
+require 'openapi_client/models/sort_by2'
+require 'openapi_client/models/sort_by3'
+require 'openapi_client/models/sort_by_date_modified'
+require 'openapi_client/models/suggestions'
+require 'openapi_client/models/template'
+require 'openapi_client/models/template_deletion'
+require 'openapi_client/models/template_list'
+require 'openapi_client/models/template_update'
+require 'openapi_client/models/template_version'
+require 'openapi_client/models/template_version_deletion'
+require 'openapi_client/models/template_version_list'
+require 'openapi_client/models/template_version_updatable'
+require 'openapi_client/models/template_version_writable'
+require 'openapi_client/models/template_writable'
+require 'openapi_client/models/thumbnail'
+require 'openapi_client/models/tracking_event_certified'
+require 'openapi_client/models/tracking_event_details'
+require 'openapi_client/models/tracking_event_normal'
+require 'openapi_client/models/upload'
+require 'openapi_client/models/upload_create_export'
+require 'openapi_client/models/upload_file'
+require 'openapi_client/models/upload_state'
+require 'openapi_client/models/upload_updatable'
+require 'openapi_client/models/upload_writable'
+require 'openapi_client/models/uploads_metadata'
+require 'openapi_client/models/us_autocompletions'
+require 'openapi_client/models/us_autocompletions_writable'
+require 'openapi_client/models/us_components'
+require 'openapi_client/models/us_verification'
+require 'openapi_client/models/us_verification_or_error'
+require 'openapi_client/models/us_verifications'
+require 'openapi_client/models/us_verifications_writable'
+require 'openapi_client/models/validation_error'
+require 'openapi_client/models/zip'
+require 'openapi_client/models/zip_code_type'
+require 'openapi_client/models/zip_editable'
+require 'openapi_client/models/zip_lookup_city'
+
+# APIs
+require 'openapi_client/api/addresses_api'
+require 'openapi_client/api/bank_accounts_api'
+require 'openapi_client/api/billing_groups_api'
+require 'openapi_client/api/buckslip_orders_api'
+require 'openapi_client/api/buckslips_api'
+require 'openapi_client/api/campaigns_api'
+require 'openapi_client/api/card_orders_api'
+require 'openapi_client/api/cards_api'
+require 'openapi_client/api/checks_api'
+require 'openapi_client/api/creatives_api'
+require 'openapi_client/api/default_api'
+require 'openapi_client/api/identity_validation_api'
+require 'openapi_client/api/intl_autocompletions_api'
+require 'openapi_client/api/intl_verifications_api'
+require 'openapi_client/api/letters_api'
+require 'openapi_client/api/postcards_api'
+require 'openapi_client/api/reverse_geocode_lookups_api'
+require 'openapi_client/api/self_mailers_api'
+require 'openapi_client/api/template_versions_api'
+require 'openapi_client/api/templates_api'
+require 'openapi_client/api/uploads_api'
+require 'openapi_client/api/us_autocompletions_api'
+require 'openapi_client/api/us_verifications_api'
+require 'openapi_client/api/zip_lookups_api'
+
+module OpenapiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   OpenapiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/openapi_client.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "openapi_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lob"
+  s.version     = Lob::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Lob"]
+  s.email       = ["support@lob.com"]
+  s.homepage    = "https://github.com/lob/lob-ruby"
+  s.summary     = %q{Ruby wrapper for Lob.com API with ActiveRecord-style syntax}
+  s.description = %q{Lob API Ruby wrapper}
+  s.license     = "MIT"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/addresses_api_spec.rb

@@ -0,0 +1,88 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Lob::AddressesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AddressesApi' do
+  before do
+    # run before each test
+    @api_instance = Lob::AddressesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AddressesApi' do
+    it 'should create an instance of AddressesApi' do
+      expect(@api_instance).to be_instance_of(Lob::AddressesApi)
+    end
+  end
+
+  # unit tests for address_create
+  # create
+  # Creates a new address given information
+  # @param address_editable 
+  # @param [Hash] opts the optional parameters
+  # @return [Address]
+  describe 'address_create test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for address_delete
+  # delete
+  # Deletes the details of an existing address.
+  # @param adr_id id of the address
+  # @param [Hash] opts the optional parameters
+  # @return [AddressDeletion]
+  describe 'address_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for address_retrieve
+  # get
+  # Retrieves the details of an existing address.
+  # @param adr_id id of the address
+  # @param [Hash] opts the optional parameters
+  # @return [Address]
+  describe 'address_retrieve test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for addresses_list
+  # list
+  # Returns a list of your addresses.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit How many results to return.
+  # @option opts [String] :before A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response. 
+  # @option opts [String] :after A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response. 
+  # @option opts [Array<String>] :include Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;. 
+  # @option opts [Hash<String, Time>] :date_created Filter by date created.
+  # @option opts [Hash<String, String>] :metadata Filter by metadata key-value pair&#x60;.
+  # @return [AddressList]
+  describe 'addresses_list test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end