zippendo 1.0.0

data/lib/zippendo/models/batch_send_shipments_request.rb

@@ -0,0 +1,185 @@
+=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 BatchSendShipmentsRequest < ApiModelBase
+    # IDs of the shipments to book. Each must be in `pending` or `error` status; duplicates are ignored. Max 100 per request.
+    attr_accessor :shipment_ids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'shipment_ids' => :'shipmentIds'
+      }
+    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
+      {
+        :'shipment_ids' => :'Array<String>'
+      }
+    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::BatchSendShipmentsRequest` 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::BatchSendShipmentsRequest`. 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?(:'shipment_ids')
+        if (value = attributes[:'shipment_ids']).is_a?(Array)
+          self.shipment_ids = value
+        end
+      else
+        self.shipment_ids = 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 @shipment_ids.nil?
+        invalid_properties.push('invalid value for "shipment_ids", shipment_ids cannot be nil.')
+      end
+
+      if @shipment_ids.length > 100
+        invalid_properties.push('invalid value for "shipment_ids", number of items must be less than or equal to 100.')
+      end
+
+      if @shipment_ids.length < 1
+        invalid_properties.push('invalid value for "shipment_ids", number of items must be greater than or equal to 1.')
+      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 @shipment_ids.nil?
+      return false if @shipment_ids.length > 100
+      return false if @shipment_ids.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] shipment_ids Value to be assigned
+    def shipment_ids=(shipment_ids)
+      if shipment_ids.nil?
+        fail ArgumentError, 'shipment_ids cannot be nil'
+      end
+
+      if shipment_ids.length > 100
+        fail ArgumentError, 'invalid value for "shipment_ids", number of items must be less than or equal to 100.'
+      end
+
+      if shipment_ids.length < 1
+        fail ArgumentError, 'invalid value for "shipment_ids", number of items must be greater than or equal to 1.'
+      end
+
+      @shipment_ids = shipment_ids
+    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 &&
+          shipment_ids == o.shipment_ids
+    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
+      [shipment_ids].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/batch_split_shipment201_response.rb

@@ -0,0 +1,193 @@
+=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 BatchSplitShipment201Response < ApiModelBase
+    attr_accessor :original_shipment
+
+    # Newly created shipments resulting from the split.
+    attr_accessor :new_shipments
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'original_shipment' => :'originalShipment',
+        :'new_shipments' => :'newShipments'
+      }
+    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
+      {
+        :'original_shipment' => :'CreateShipment201Response',
+        :'new_shipments' => :'Array<CreateShipment201Response>'
+      }
+    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::BatchSplitShipment201Response` 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::BatchSplitShipment201Response`. 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?(:'original_shipment')
+        self.original_shipment = attributes[:'original_shipment']
+      else
+        self.original_shipment = nil
+      end
+
+      if attributes.key?(:'new_shipments')
+        if (value = attributes[:'new_shipments']).is_a?(Array)
+          self.new_shipments = value
+        end
+      else
+        self.new_shipments = 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 @original_shipment.nil?
+        invalid_properties.push('invalid value for "original_shipment", original_shipment cannot be nil.')
+      end
+
+      if @new_shipments.nil?
+        invalid_properties.push('invalid value for "new_shipments", new_shipments 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 @original_shipment.nil?
+      return false if @new_shipments.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] original_shipment Value to be assigned
+    def original_shipment=(original_shipment)
+      if original_shipment.nil?
+        fail ArgumentError, 'original_shipment cannot be nil'
+      end
+
+      @original_shipment = original_shipment
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] new_shipments Value to be assigned
+    def new_shipments=(new_shipments)
+      if new_shipments.nil?
+        fail ArgumentError, 'new_shipments cannot be nil'
+      end
+
+      @new_shipments = new_shipments
+    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 &&
+          original_shipment == o.original_shipment &&
+          new_shipments == o.new_shipments
+    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
+      [original_shipment, new_shipments].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/batch_split_shipment_request.rb

@@ -0,0 +1,247 @@
+=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 BatchSplitShipmentRequest < ApiModelBase
+    # Parcel whose order lines are split across new shipments.
+    attr_accessor :parcel_id
+
+    # New shipments to create from the split parcel.
+    attr_accessor :shipments
+
+    # Carrier for all new shipments. Copied from the original if omitted.
+    attr_accessor :carrier_id
+
+    # Carrier product for all new shipments. Copied from the original if omitted.
+    attr_accessor :product_id
+
+    # Service codes for all new shipments. Copied from the original if omitted.
+    attr_accessor :services
+
+    # Carrier-specific parameters for all new shipments.
+    attr_accessor :additional_parameters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'parcel_id' => :'parcelId',
+        :'shipments' => :'shipments',
+        :'carrier_id' => :'carrierId',
+        :'product_id' => :'productId',
+        :'services' => :'services',
+        :'additional_parameters' => :'additionalParameters'
+      }
+    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
+      {
+        :'parcel_id' => :'String',
+        :'shipments' => :'Array<BatchSplitShipmentRequestShipmentsInner>',
+        :'carrier_id' => :'String',
+        :'product_id' => :'String',
+        :'services' => :'Array<String>',
+        :'additional_parameters' => :'Hash<String, Object>'
+      }
+    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::BatchSplitShipmentRequest` 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::BatchSplitShipmentRequest`. 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?(:'parcel_id')
+        self.parcel_id = attributes[:'parcel_id']
+      else
+        self.parcel_id = nil
+      end
+
+      if attributes.key?(:'shipments')
+        if (value = attributes[:'shipments']).is_a?(Array)
+          self.shipments = value
+        end
+      else
+        self.shipments = nil
+      end
+
+      if attributes.key?(:'carrier_id')
+        self.carrier_id = attributes[:'carrier_id']
+      end
+
+      if attributes.key?(:'product_id')
+        self.product_id = attributes[:'product_id']
+      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?(Hash)
+          self.additional_parameters = 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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @parcel_id.nil?
+        invalid_properties.push('invalid value for "parcel_id", parcel_id cannot be nil.')
+      end
+
+      if @shipments.nil?
+        invalid_properties.push('invalid value for "shipments", shipments cannot be nil.')
+      end
+
+      if @shipments.length < 1
+        invalid_properties.push('invalid value for "shipments", number of items must be greater than or equal to 1.')
+      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 @parcel_id.nil?
+      return false if @shipments.nil?
+      return false if @shipments.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] parcel_id Value to be assigned
+    def parcel_id=(parcel_id)
+      if parcel_id.nil?
+        fail ArgumentError, 'parcel_id cannot be nil'
+      end
+
+      @parcel_id = parcel_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] shipments Value to be assigned
+    def shipments=(shipments)
+      if shipments.nil?
+        fail ArgumentError, 'shipments cannot be nil'
+      end
+
+      if shipments.length < 1
+        fail ArgumentError, 'invalid value for "shipments", number of items must be greater than or equal to 1.'
+      end
+
+      @shipments = shipments
+    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 &&
+          parcel_id == o.parcel_id &&
+          shipments == o.shipments &&
+          carrier_id == o.carrier_id &&
+          product_id == o.product_id &&
+          services == o.services &&
+          additional_parameters == o.additional_parameters
+    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
+      [parcel_id, shipments, carrier_id, product_id, services, additional_parameters].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