zippendo 1.0.0

data/lib/zippendo/models/create_shipping_rule_request.rb

@@ -0,0 +1,640 @@
+=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 CreateShippingRuleRequest < ApiModelBase
+    # Shipping rule name
+    attr_accessor :name
+
+    # Optional description
+    attr_accessor :description
+
+    # Whether this rule is for outbound or inbound (return) shipments
+    attr_accessor :direction
+
+    # Carrier ID
+    attr_accessor :carrier_id
+
+    # Product ID from carrier
+    attr_accessor :product_id
+
+    # List of selected services
+    attr_accessor :services
+
+    attr_accessor :additional_parameters
+
+    # Sender address ID
+    attr_accessor :address_id
+
+    # List of supported country codes
+    attr_accessor :receiving_countries
+
+    # Send email notification to recipient
+    attr_accessor :email_notification
+
+    # Send SMS notification to recipient
+    attr_accessor :phone_notification
+
+    # Minimum required weight in kg
+    attr_accessor :min_weight
+
+    # Maximum allowed weight in kg
+    attr_accessor :max_weight
+
+    # Minimum required order value in currency units
+    attr_accessor :min_order_value
+
+    # Maximum allowed order value in currency units
+    attr_accessor :max_order_value
+
+    # Rule conditions (weight/price/quantity)
+    attr_accessor :conditions
+
+    # Generate proforma invoice for shipments
+    attr_accessor :generate_proforma_invoice
+
+    # Generate commercial invoice for international shipments
+    attr_accessor :generate_commercial_invoice
+
+    # Generate packing slip with package and item details
+    attr_accessor :generate_packing_list
+
+    # Automatically print labels when shipment is sent
+    attr_accessor :auto_print_labels
+
+    # Automatically print documents when shipment is sent
+    attr_accessor :auto_print_documents
+
+    # ID of the label printer
+    attr_accessor :label_printer_id
+
+    # ID of the document printer
+    attr_accessor :document_printer_id
+
+    # ID of the return shipping rule
+    attr_accessor :return_shipping_rule_id
+
+    # Automatically create and send a return shipment on dispatch
+    attr_accessor :auto_create_return_shipment
+
+    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',
+        :'description' => :'description',
+        :'direction' => :'direction',
+        :'carrier_id' => :'carrierId',
+        :'product_id' => :'productId',
+        :'services' => :'services',
+        :'additional_parameters' => :'additionalParameters',
+        :'address_id' => :'addressId',
+        :'receiving_countries' => :'receivingCountries',
+        :'email_notification' => :'emailNotification',
+        :'phone_notification' => :'phoneNotification',
+        :'min_weight' => :'minWeight',
+        :'max_weight' => :'maxWeight',
+        :'min_order_value' => :'minOrderValue',
+        :'max_order_value' => :'maxOrderValue',
+        :'conditions' => :'conditions',
+        :'generate_proforma_invoice' => :'generateProformaInvoice',
+        :'generate_commercial_invoice' => :'generateCommercialInvoice',
+        :'generate_packing_list' => :'generatePackingList',
+        :'auto_print_labels' => :'autoPrintLabels',
+        :'auto_print_documents' => :'autoPrintDocuments',
+        :'label_printer_id' => :'labelPrinterId',
+        :'document_printer_id' => :'documentPrinterId',
+        :'return_shipping_rule_id' => :'returnShippingRuleId',
+        :'auto_create_return_shipment' => :'autoCreateReturnShipment'
+      }
+    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',
+        :'description' => :'String',
+        :'direction' => :'String',
+        :'carrier_id' => :'String',
+        :'product_id' => :'String',
+        :'services' => :'Array<String>',
+        :'additional_parameters' => :'CreateShippingRuleRequestAdditionalParameters',
+        :'address_id' => :'String',
+        :'receiving_countries' => :'Array<String>',
+        :'email_notification' => :'Boolean',
+        :'phone_notification' => :'Boolean',
+        :'min_weight' => :'Float',
+        :'max_weight' => :'Float',
+        :'min_order_value' => :'Float',
+        :'max_order_value' => :'Float',
+        :'conditions' => :'Array<CreateShippingRuleRequestConditionsInner>',
+        :'generate_proforma_invoice' => :'Boolean',
+        :'generate_commercial_invoice' => :'Boolean',
+        :'generate_packing_list' => :'Boolean',
+        :'auto_print_labels' => :'Boolean',
+        :'auto_print_documents' => :'Boolean',
+        :'label_printer_id' => :'String',
+        :'document_printer_id' => :'String',
+        :'return_shipping_rule_id' => :'String',
+        :'auto_create_return_shipment' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'min_weight',
+        :'max_weight',
+        :'min_order_value',
+        :'max_order_value',
+        :'label_printer_id',
+        :'document_printer_id',
+        :'return_shipping_rule_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::CreateShippingRuleRequest` 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::CreateShippingRuleRequest`. 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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'direction')
+        self.direction = attributes[:'direction']
+      else
+        self.direction = 'outbound'
+      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?(:'additional_parameters')
+        self.additional_parameters = attributes[:'additional_parameters']
+      end
+
+      if attributes.key?(:'address_id')
+        self.address_id = attributes[:'address_id']
+      else
+        self.address_id = nil
+      end
+
+      if attributes.key?(:'receiving_countries')
+        if (value = attributes[:'receiving_countries']).is_a?(Array)
+          self.receiving_countries = value
+        end
+      else
+        self.receiving_countries = nil
+      end
+
+      if attributes.key?(:'email_notification')
+        self.email_notification = attributes[:'email_notification']
+      else
+        self.email_notification = false
+      end
+
+      if attributes.key?(:'phone_notification')
+        self.phone_notification = attributes[:'phone_notification']
+      else
+        self.phone_notification = false
+      end
+
+      if attributes.key?(:'min_weight')
+        self.min_weight = attributes[:'min_weight']
+      end
+
+      if attributes.key?(:'max_weight')
+        self.max_weight = attributes[:'max_weight']
+      end
+
+      if attributes.key?(:'min_order_value')
+        self.min_order_value = attributes[:'min_order_value']
+      end
+
+      if attributes.key?(:'max_order_value')
+        self.max_order_value = attributes[:'max_order_value']
+      end
+
+      if attributes.key?(:'conditions')
+        if (value = attributes[:'conditions']).is_a?(Array)
+          self.conditions = value
+        end
+      else
+        self.conditions = nil
+      end
+
+      if attributes.key?(:'generate_proforma_invoice')
+        self.generate_proforma_invoice = attributes[:'generate_proforma_invoice']
+      else
+        self.generate_proforma_invoice = false
+      end
+
+      if attributes.key?(:'generate_commercial_invoice')
+        self.generate_commercial_invoice = attributes[:'generate_commercial_invoice']
+      else
+        self.generate_commercial_invoice = false
+      end
+
+      if attributes.key?(:'generate_packing_list')
+        self.generate_packing_list = attributes[:'generate_packing_list']
+      else
+        self.generate_packing_list = false
+      end
+
+      if attributes.key?(:'auto_print_labels')
+        self.auto_print_labels = attributes[:'auto_print_labels']
+      else
+        self.auto_print_labels = false
+      end
+
+      if attributes.key?(:'auto_print_documents')
+        self.auto_print_documents = attributes[:'auto_print_documents']
+      else
+        self.auto_print_documents = false
+      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
+
+      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']
+      else
+        self.auto_create_return_shipment = false
+      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 @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
+      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
+
+      if @receiving_countries.nil?
+        invalid_properties.push('invalid value for "receiving_countries", receiving_countries cannot be nil.')
+      end
+
+      if !@min_weight.nil? && @min_weight < 0
+        invalid_properties.push('invalid value for "min_weight", must be greater than or equal to 0.')
+      end
+
+      if !@max_weight.nil? && @max_weight < 0
+        invalid_properties.push('invalid value for "max_weight", must be greater than or equal to 0.')
+      end
+
+      if !@min_order_value.nil? && @min_order_value < 0
+        invalid_properties.push('invalid value for "min_order_value", must be greater than or equal to 0.')
+      end
+
+      if !@max_order_value.nil? && @max_order_value < 0
+        invalid_properties.push('invalid value for "max_order_value", must be greater than or equal to 0.')
+      end
+
+      if @conditions.nil?
+        invalid_properties.push('invalid value for "conditions", conditions 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 @name.to_s.length < 1
+      direction_validator = EnumAttributeValidator.new('String', ["outbound", "inbound"])
+      return false unless direction_validator.valid?(@direction)
+      return false if @carrier_id.nil?
+      return false if @product_id.nil?
+      return false if @services.nil?
+      return false if @address_id.nil?
+      return false if @receiving_countries.nil?
+      return false if !@min_weight.nil? && @min_weight < 0
+      return false if !@max_weight.nil? && @max_weight < 0
+      return false if !@min_order_value.nil? && @min_order_value < 0
+      return false if !@max_order_value.nil? && @max_order_value < 0
+      return false if @conditions.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
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] direction Object to be assigned
+    def direction=(direction)
+      validator = EnumAttributeValidator.new('String', ["outbound", "inbound"])
+      unless validator.valid?(direction)
+        fail ArgumentError, "invalid value for \"direction\", must be one of #{validator.allowable_values}."
+      end
+      @direction = direction
+    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
+
+    # Custom attribute writer method with validation
+    # @param [Object] receiving_countries Value to be assigned
+    def receiving_countries=(receiving_countries)
+      if receiving_countries.nil?
+        fail ArgumentError, 'receiving_countries cannot be nil'
+      end
+
+      @receiving_countries = receiving_countries
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_weight Value to be assigned
+    def min_weight=(min_weight)
+      if !min_weight.nil? && min_weight < 0
+        fail ArgumentError, 'invalid value for "min_weight", must be greater than or equal to 0.'
+      end
+
+      @min_weight = min_weight
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_weight Value to be assigned
+    def max_weight=(max_weight)
+      if !max_weight.nil? && max_weight < 0
+        fail ArgumentError, 'invalid value for "max_weight", must be greater than or equal to 0.'
+      end
+
+      @max_weight = max_weight
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] min_order_value Value to be assigned
+    def min_order_value=(min_order_value)
+      if !min_order_value.nil? && min_order_value < 0
+        fail ArgumentError, 'invalid value for "min_order_value", must be greater than or equal to 0.'
+      end
+
+      @min_order_value = min_order_value
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_order_value Value to be assigned
+    def max_order_value=(max_order_value)
+      if !max_order_value.nil? && max_order_value < 0
+        fail ArgumentError, 'invalid value for "max_order_value", must be greater than or equal to 0.'
+      end
+
+      @max_order_value = max_order_value
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] conditions Value to be assigned
+    def conditions=(conditions)
+      if conditions.nil?
+        fail ArgumentError, 'conditions cannot be nil'
+      end
+
+      @conditions = conditions
+    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 &&
+          description == o.description &&
+          direction == o.direction &&
+          carrier_id == o.carrier_id &&
+          product_id == o.product_id &&
+          services == o.services &&
+          additional_parameters == o.additional_parameters &&
+          address_id == o.address_id &&
+          receiving_countries == o.receiving_countries &&
+          email_notification == o.email_notification &&
+          phone_notification == o.phone_notification &&
+          min_weight == o.min_weight &&
+          max_weight == o.max_weight &&
+          min_order_value == o.min_order_value &&
+          max_order_value == o.max_order_value &&
+          conditions == o.conditions &&
+          generate_proforma_invoice == o.generate_proforma_invoice &&
+          generate_commercial_invoice == o.generate_commercial_invoice &&
+          generate_packing_list == o.generate_packing_list &&
+          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 &&
+          return_shipping_rule_id == o.return_shipping_rule_id &&
+          auto_create_return_shipment == o.auto_create_return_shipment
+    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, description, direction, carrier_id, product_id, services, additional_parameters, address_id, receiving_countries, email_notification, phone_notification, min_weight, max_weight, min_order_value, max_order_value, conditions, generate_proforma_invoice, generate_commercial_invoice, generate_packing_list, auto_print_labels, auto_print_documents, label_printer_id, document_printer_id, return_shipping_rule_id, auto_create_return_shipment].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