zippendo 1.0.0

data/lib/zippendo/models/list_carrier_product_service_points_request.rb

@@ -0,0 +1,313 @@
+=begin
+#Zippendo Public API
+
+#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@zippendo.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zippendo
+  class ListCarrierProductServicePointsRequest < ApiModelBase
+    # Street address line 1
+    attr_accessor :address1
+
+    # Street address line 2
+    attr_accessor :address2
+
+    # Postal code
+    attr_accessor :postal_code
+
+    # State or region
+    attr_accessor :state
+
+    # City name
+    attr_accessor :city
+
+    # ISO 3166-1 alpha-2 country code
+    attr_accessor :country_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'address1' => :'address1',
+        :'address2' => :'address2',
+        :'postal_code' => :'postalCode',
+        :'state' => :'state',
+        :'city' => :'city',
+        :'country_code' => :'countryCode'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'address1' => :'String',
+        :'address2' => :'String',
+        :'postal_code' => :'String',
+        :'state' => :'String',
+        :'city' => :'String',
+        :'country_code' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'address2',
+        :'state',
+      ])
+    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 `Zippendo::ListCarrierProductServicePointsRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zippendo::ListCarrierProductServicePointsRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'address1')
+        self.address1 = attributes[:'address1']
+      else
+        self.address1 = nil
+      end
+
+      if attributes.key?(:'address2')
+        self.address2 = attributes[:'address2']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      else
+        self.postal_code = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      else
+        self.city = nil
+      end
+
+      if attributes.key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      else
+        self.country_code = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @address1.nil?
+        invalid_properties.push('invalid value for "address1", address1 cannot be nil.')
+      end
+
+      if @address1.to_s.length < 1
+        invalid_properties.push('invalid value for "address1", the character length must be greater than or equal to 1.')
+      end
+
+      if @postal_code.nil?
+        invalid_properties.push('invalid value for "postal_code", postal_code cannot be nil.')
+      end
+
+      if @postal_code.to_s.length < 1
+        invalid_properties.push('invalid value for "postal_code", the character length must be greater than or equal to 1.')
+      end
+
+      if @city.nil?
+        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      end
+
+      if @city.to_s.length < 1
+        invalid_properties.push('invalid value for "city", the character length must be greater than or equal to 1.')
+      end
+
+      if @country_code.nil?
+        invalid_properties.push('invalid value for "country_code", country_code cannot be nil.')
+      end
+
+      if @country_code.to_s.length > 2
+        invalid_properties.push('invalid value for "country_code", the character length must be smaller than or equal to 2.')
+      end
+
+      if @country_code.to_s.length < 2
+        invalid_properties.push('invalid value for "country_code", the character length must be greater than or equal to 2.')
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @address1.nil?
+      return false if @address1.to_s.length < 1
+      return false if @postal_code.nil?
+      return false if @postal_code.to_s.length < 1
+      return false if @city.nil?
+      return false if @city.to_s.length < 1
+      return false if @country_code.nil?
+      return false if @country_code.to_s.length > 2
+      return false if @country_code.to_s.length < 2
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address1 Value to be assigned
+    def address1=(address1)
+      if address1.nil?
+        fail ArgumentError, 'address1 cannot be nil'
+      end
+
+      if address1.to_s.length < 1
+        fail ArgumentError, 'invalid value for "address1", the character length must be greater than or equal to 1.'
+      end
+
+      @address1 = address1
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      if postal_code.nil?
+        fail ArgumentError, 'postal_code cannot be nil'
+      end
+
+      if postal_code.to_s.length < 1
+        fail ArgumentError, 'invalid value for "postal_code", the character length must be greater than or equal to 1.'
+      end
+
+      @postal_code = postal_code
+    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 < 1
+        fail ArgumentError, 'invalid value for "city", the character length must be greater than or equal to 1.'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country_code Value to be assigned
+    def country_code=(country_code)
+      if country_code.nil?
+        fail ArgumentError, 'country_code cannot be nil'
+      end
+
+      if country_code.to_s.length > 2
+        fail ArgumentError, 'invalid value for "country_code", the character length must be smaller than or equal to 2.'
+      end
+
+      if country_code.to_s.length < 2
+        fail ArgumentError, 'invalid value for "country_code", the character length must be greater than or equal to 2.'
+      end
+
+      @country_code = country_code
+    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 &&
+          address1 == o.address1 &&
+          address2 == o.address2 &&
+          postal_code == o.postal_code &&
+          state == o.state &&
+          city == o.city &&
+          country_code == o.country_code
+    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
+      [address1, address2, postal_code, state, city, country_code].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        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
+
+  end
+
+end

data/lib/zippendo/models/list_carrier_products200_response_inner.rb

@@ -0,0 +1,398 @@
+=begin
+#Zippendo Public API
+
+#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@zippendo.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zippendo
+  class ListCarrierProducts200ResponseInner < ApiModelBase
+    # Display name of the shipping product
+    attr_accessor :name
+
+    # Unique carrier product identifier
+    attr_accessor :product_id
+
+    # Direction of the shipment for this product
+    attr_accessor :type
+
+    # Description of the shipping product
+    attr_accessor :description
+
+    # Recipient countries supported by this product
+    attr_accessor :available_countries
+
+    # Sender countries supported by this product
+    attr_accessor :available_sender_countries
+
+    # Whether delivery is to a service point/pickup location
+    attr_accessor :is_service_point
+
+    # Whether carrier pickup is available for this product
+    attr_accessor :is_pickup_available
+
+    # Additional services available for this product
+    attr_accessor :services
+
+    # Extra parameters that can or must be supplied for this product
+    attr_accessor :additional_parameters
+
+    attr_accessor :weight_limits
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'product_id' => :'productId',
+        :'type' => :'type',
+        :'description' => :'description',
+        :'available_countries' => :'availableCountries',
+        :'available_sender_countries' => :'availableSenderCountries',
+        :'is_service_point' => :'isServicePoint',
+        :'is_pickup_available' => :'isPickupAvailable',
+        :'services' => :'services',
+        :'additional_parameters' => :'additionalParameters',
+        :'weight_limits' => :'weightLimits'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'product_id' => :'String',
+        :'type' => :'String',
+        :'description' => :'String',
+        :'available_countries' => :'Array<String>',
+        :'available_sender_countries' => :'Array<String>',
+        :'is_service_point' => :'Boolean',
+        :'is_pickup_available' => :'Boolean',
+        :'services' => :'Array<ListCarrierProducts200ResponseInnerServicesInner>',
+        :'additional_parameters' => :'Array<ListCarrierProducts200ResponseInnerAdditionalParametersInner>',
+        :'weight_limits' => :'ListCarrierProducts200ResponseInnerWeightLimits'
+      }
+    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 `Zippendo::ListCarrierProducts200ResponseInner` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zippendo::ListCarrierProducts200ResponseInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'product_id')
+        self.product_id = attributes[:'product_id']
+      else
+        self.product_id = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'available_countries')
+        if (value = attributes[:'available_countries']).is_a?(Array)
+          self.available_countries = value
+        end
+      else
+        self.available_countries = nil
+      end
+
+      if attributes.key?(:'available_sender_countries')
+        if (value = attributes[:'available_sender_countries']).is_a?(Array)
+          self.available_sender_countries = value
+        end
+      else
+        self.available_sender_countries = nil
+      end
+
+      if attributes.key?(:'is_service_point')
+        self.is_service_point = attributes[:'is_service_point']
+      else
+        self.is_service_point = false
+      end
+
+      if attributes.key?(:'is_pickup_available')
+        self.is_pickup_available = attributes[:'is_pickup_available']
+      else
+        self.is_pickup_available = false
+      end
+
+      if attributes.key?(:'services')
+        if (value = attributes[:'services']).is_a?(Array)
+          self.services = value
+        end
+      end
+
+      if attributes.key?(:'additional_parameters')
+        if (value = attributes[:'additional_parameters']).is_a?(Array)
+          self.additional_parameters = value
+        end
+      end
+
+      if attributes.key?(:'weight_limits')
+        self.weight_limits = attributes[:'weight_limits']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @product_id.nil?
+        invalid_properties.push('invalid value for "product_id", product_id cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @available_countries.nil?
+        invalid_properties.push('invalid value for "available_countries", available_countries cannot be nil.')
+      end
+
+      if @available_sender_countries.nil?
+        invalid_properties.push('invalid value for "available_sender_countries", available_sender_countries cannot be nil.')
+      end
+
+      if @is_service_point.nil?
+        invalid_properties.push('invalid value for "is_service_point", is_service_point cannot be nil.')
+      end
+
+      if @is_pickup_available.nil?
+        invalid_properties.push('invalid value for "is_pickup_available", is_pickup_available 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @name.nil?
+      return false if @product_id.nil?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["outbound", "inbound"])
+      return false unless type_validator.valid?(@type)
+      return false if @available_countries.nil?
+      return false if @available_sender_countries.nil?
+      return false if @is_service_point.nil?
+      return false if @is_pickup_available.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] product_id Value to be assigned
+    def product_id=(product_id)
+      if product_id.nil?
+        fail ArgumentError, 'product_id cannot be nil'
+      end
+
+      @product_id = product_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["outbound", "inbound"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] available_countries Value to be assigned
+    def available_countries=(available_countries)
+      if available_countries.nil?
+        fail ArgumentError, 'available_countries cannot be nil'
+      end
+
+      @available_countries = available_countries
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] available_sender_countries Value to be assigned
+    def available_sender_countries=(available_sender_countries)
+      if available_sender_countries.nil?
+        fail ArgumentError, 'available_sender_countries cannot be nil'
+      end
+
+      @available_sender_countries = available_sender_countries
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_service_point Value to be assigned
+    def is_service_point=(is_service_point)
+      if is_service_point.nil?
+        fail ArgumentError, 'is_service_point cannot be nil'
+      end
+
+      @is_service_point = is_service_point
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_pickup_available Value to be assigned
+    def is_pickup_available=(is_pickup_available)
+      if is_pickup_available.nil?
+        fail ArgumentError, 'is_pickup_available cannot be nil'
+      end
+
+      @is_pickup_available = is_pickup_available
+    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 &&
+          name == o.name &&
+          product_id == o.product_id &&
+          type == o.type &&
+          description == o.description &&
+          available_countries == o.available_countries &&
+          available_sender_countries == o.available_sender_countries &&
+          is_service_point == o.is_service_point &&
+          is_pickup_available == o.is_pickup_available &&
+          services == o.services &&
+          additional_parameters == o.additional_parameters &&
+          weight_limits == o.weight_limits
+    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
+      [name, product_id, type, description, available_countries, available_sender_countries, is_service_point, is_pickup_available, services, additional_parameters, weight_limits].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        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
+
+  end
+
+end