zippendo 1.0.0

data/lib/zippendo/models/get_order200_response_shipping_rule.rb

@@ -0,0 +1,365 @@
+=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 GetOrder200ResponseShippingRule < ApiModelBase
+    # Unique shipping rule identifier.
+    attr_accessor :id
+
+    # Display name of the shipping rule.
+    attr_accessor :name
+
+    # Carrier applied by the rule.
+    attr_accessor :carrier_id
+
+    # Carrier product applied by the rule.
+    attr_accessor :product_id
+
+    # Additional service codes applied by the rule.
+    attr_accessor :services
+
+    # Sender address applied by the rule.
+    attr_accessor :address_id
+
+    # ID of the linked return shipping rule.
+    attr_accessor :return_shipping_rule_id
+
+    # Whether a return shipment is created automatically.
+    attr_accessor :auto_create_return_shipment
+
+    # Whether labels are printed automatically on send.
+    attr_accessor :auto_print_labels
+
+    # Whether documents are printed automatically on send.
+    attr_accessor :auto_print_documents
+
+    # Printer used for labels.
+    attr_accessor :label_printer_id
+
+    # Printer used for documents.
+    attr_accessor :document_printer_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'carrier_id' => :'carrierId',
+        :'product_id' => :'productId',
+        :'services' => :'services',
+        :'address_id' => :'addressId',
+        :'return_shipping_rule_id' => :'returnShippingRuleId',
+        :'auto_create_return_shipment' => :'autoCreateReturnShipment',
+        :'auto_print_labels' => :'autoPrintLabels',
+        :'auto_print_documents' => :'autoPrintDocuments',
+        :'label_printer_id' => :'labelPrinterId',
+        :'document_printer_id' => :'documentPrinterId'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'carrier_id' => :'String',
+        :'product_id' => :'String',
+        :'services' => :'Array<String>',
+        :'address_id' => :'String',
+        :'return_shipping_rule_id' => :'String',
+        :'auto_create_return_shipment' => :'Boolean',
+        :'auto_print_labels' => :'Boolean',
+        :'auto_print_documents' => :'Boolean',
+        :'label_printer_id' => :'String',
+        :'document_printer_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'return_shipping_rule_id',
+        :'label_printer_id',
+        :'document_printer_id'
+      ])
+    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::GetOrder200ResponseShippingRule` 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::GetOrder200ResponseShippingRule`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'carrier_id')
+        self.carrier_id = attributes[:'carrier_id']
+      else
+        self.carrier_id = nil
+      end
+
+      if attributes.key?(:'product_id')
+        self.product_id = attributes[:'product_id']
+      else
+        self.product_id = nil
+      end
+
+      if attributes.key?(:'services')
+        if (value = attributes[:'services']).is_a?(Array)
+          self.services = value
+        end
+      else
+        self.services = nil
+      end
+
+      if attributes.key?(:'address_id')
+        self.address_id = attributes[:'address_id']
+      else
+        self.address_id = nil
+      end
+
+      if attributes.key?(:'return_shipping_rule_id')
+        self.return_shipping_rule_id = attributes[:'return_shipping_rule_id']
+      end
+
+      if attributes.key?(:'auto_create_return_shipment')
+        self.auto_create_return_shipment = attributes[:'auto_create_return_shipment']
+      end
+
+      if attributes.key?(:'auto_print_labels')
+        self.auto_print_labels = attributes[:'auto_print_labels']
+      end
+
+      if attributes.key?(:'auto_print_documents')
+        self.auto_print_documents = attributes[:'auto_print_documents']
+      end
+
+      if attributes.key?(:'label_printer_id')
+        self.label_printer_id = attributes[:'label_printer_id']
+      end
+
+      if attributes.key?(:'document_printer_id')
+        self.document_printer_id = attributes[:'document_printer_id']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @carrier_id.nil?
+        invalid_properties.push('invalid value for "carrier_id", carrier_id cannot be nil.')
+      end
+
+      if @product_id.nil?
+        invalid_properties.push('invalid value for "product_id", product_id cannot be nil.')
+      end
+
+      if @services.nil?
+        invalid_properties.push('invalid value for "services", services cannot be nil.')
+      end
+
+      if @address_id.nil?
+        invalid_properties.push('invalid value for "address_id", address_id 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 @id.nil?
+      return false if @name.nil?
+      return false if @carrier_id.nil?
+      return false if @product_id.nil?
+      return false if @services.nil?
+      return false if @address_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    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] carrier_id Value to be assigned
+    def carrier_id=(carrier_id)
+      if carrier_id.nil?
+        fail ArgumentError, 'carrier_id cannot be nil'
+      end
+
+      @carrier_id = carrier_id
+    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 with validation
+    # @param [Object] services Value to be assigned
+    def services=(services)
+      if services.nil?
+        fail ArgumentError, 'services cannot be nil'
+      end
+
+      @services = services
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address_id Value to be assigned
+    def address_id=(address_id)
+      if address_id.nil?
+        fail ArgumentError, 'address_id cannot be nil'
+      end
+
+      @address_id = address_id
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          carrier_id == o.carrier_id &&
+          product_id == o.product_id &&
+          services == o.services &&
+          address_id == o.address_id &&
+          return_shipping_rule_id == o.return_shipping_rule_id &&
+          auto_create_return_shipment == o.auto_create_return_shipment &&
+          auto_print_labels == o.auto_print_labels &&
+          auto_print_documents == o.auto_print_documents &&
+          label_printer_id == o.label_printer_id &&
+          document_printer_id == o.document_printer_id
+    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
+      [id, name, carrier_id, product_id, services, address_id, return_shipping_rule_id, auto_create_return_shipment, auto_print_labels, auto_print_documents, label_printer_id, document_printer_id].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