ship_engine 1.0.0

data/lib/openapi_client/models/insurance_provider.rb

@@ -0,0 +1,38 @@
+=begin
+#ShipEngine API
+
+#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices.  Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service.  ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips.  Here are some step-by-step **tutorials** to get you started:    - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/)   - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/)   - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/)   - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/)   ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/).   ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is.   ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info.   ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others. 
+
+The version of the OpenAPI document: 1.1.202006302006
+Contact: sales@shipengine.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  class InsuranceProvider
+    NONE = "none".freeze
+    SHIPSURANCE = "shipsurance".freeze
+    CARRIER = "carrier".freeze
+    THIRD_PARTY = "third_party".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = InsuranceProvider.constants.select { |c| InsuranceProvider::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #InsuranceProvider" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/openapi_client/models/international_shipment_options.rb

@@ -0,0 +1,240 @@
+=begin
+#ShipEngine API
+
+#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices.  Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service.  ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips.  Here are some step-by-step **tutorials** to get you started:    - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/)   - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/)   - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/)   - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/)   ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/).   ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is.   ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info.   ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others. 
+
+The version of the OpenAPI document: 1.1.202006302006
+Contact: sales@shipengine.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # Options for international shipments, such as customs declarations.
+  class InternationalShipmentOptions
+    # The type of contents in this shipment.  This may impact import duties or customs treatment.
+    attr_accessor :contents
+
+    # Indicates what to do if a package is unable to be delivered.
+    attr_accessor :non_delivery
+
+    # Customs declarations for each item in the shipment.
+    attr_accessor :customs_items
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'contents' => :'contents',
+        :'non_delivery' => :'non_delivery',
+        :'customs_items' => :'customs_items'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'contents' => :'PackageContents',
+        :'non_delivery' => :'NonDelivery',
+        :'customs_items' => :'Array<CustomsItem>'
+      }
+    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 `OpenapiClient::InternationalShipmentOptions` 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 `OpenapiClient::InternationalShipmentOptions`. 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?(:'contents')
+        self.contents = attributes[:'contents']
+      end
+
+      if attributes.key?(:'non_delivery')
+        self.non_delivery = attributes[:'non_delivery']
+      end
+
+      if attributes.key?(:'customs_items')
+        if (value = attributes[:'customs_items']).is_a?(Array)
+          self.customs_items = 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
+      invalid_properties = Array.new
+      if @contents.nil?
+        invalid_properties.push('invalid value for "contents", contents cannot be nil.')
+      end
+
+      if @non_delivery.nil?
+        invalid_properties.push('invalid value for "non_delivery", non_delivery 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 @contents.nil?
+      return false if @non_delivery.nil?
+      true
+    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 &&
+          contents == o.contents &&
+          non_delivery == o.non_delivery &&
+          customs_items == o.customs_items
+    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
+      [contents, non_delivery, customs_items].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)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        OpenapiClient.const_get(type).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)
+        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/models/label.rb

@@ -0,0 +1,548 @@
+=begin
+#ShipEngine API
+
+#ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices.  Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service.  ## Getting Started If you're new to REST APIs then be sure to read our [introduction to REST](https://www.shipengine.com/docs/rest/) to understand the basics. Learn how to [authenticate yourself to ShipEngine](https://www.shipengine.com/docs/auth/), and then use our [sandbox environment](https://www.shipengine.com/docs/sandbox/) to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the [error handling guide](https://www.shipengine.com/docs/errors/) for tips.  Here are some step-by-step **tutorials** to get you started:    - [Learn how to create your first shipping label](https://www.shipengine.com/docs/labels/create-a-label/)   - [Calculate shipping costs and compare rates across carriers](https://www.shipengine.com/docs/rates/)   - [Track packages on-demand or in real time](https://www.shipengine.com/docs/tracking/)   - [Validate mailing addresses anywhere on Earth](https://www.shipengine.com/docs/addresses/validation/)   ## Shipping Labels for Every Major Carrier ShipEngine makes it easy to [create shipping labels for any carrier](https://www.shipengine.com/docs/labels/create-a-label/) and [download them](https://www.shipengine.com/docs/labels/downloading/) in a [variety of file formats](https://www.shipengine.com/docs/labels/formats/). You can even customize labels with your own [messages](https://www.shipengine.com/docs/labels/messages/) and [images](https://www.shipengine.com/docs/labels/branding/).   ## Real-Time Package Tracking With ShipEngine you can [get the current status of a package](https://www.shipengine.com/docs/tracking/) or [subscribe to real-time tracking updates](https://www.shipengine.com/docs/tracking/webhooks/) via webhooks. You can also create [custimized tracking pages](https://www.shipengine.com/docs/tracking/branded-tracking-page/) with your own branding so your customers will always know where their package is.   ## Compare Shipping Costs Across Carriers Make sure you ship as cost-effectively as possible by [comparing rates across carriers](https://www.shipengine.com/docs/rates/get-shipment-rates/) using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can [get rate estimates](https://www.shipengine.com/docs/rates/estimate/) with limited address info.   ## Worldwide Address Validation ShipEngine supports [address validation](https://www.shipengine.com/docs/addresses/validation/) for virtually [every country on Earth](https://www.shipengine.com/docs/addresses/validation/countries/), including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others. 
+
+The version of the OpenAPI document: 1.1.202006302006
+Contact: sales@shipengine.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module OpenapiClient
+  # A label represents the physical sticker that you affix to a package to ship it.  ShipEngine makes it easy for you to [create labels](https://www.shipengine.com/docs/labels/create-a-label/) and then download them in PDF, PNG, or ZPL format so you can print them. 
+  class Label
+    # A string that uniquely identifies the label. This ID is generated by ShipEngine when the label is created. 
+    attr_accessor :label_id
+
+    attr_accessor :status
+
+    # The shipment that this label is for.  ShipEngine can create a shipment for you automatically when you [create a label](https://www.shipengine.com/docs/labels/create-a-label/), or you can [create your own shipment](https://www.shipengine.com/docs/shipping/create-a-shipment/) and then [use it to print a label](https://www.shipengine.com/docs/labels/create-from-shipment/) 
+    attr_accessor :shipment_id
+
+    # The shipment information used to generate the label
+    attr_accessor :shipment
+
+    # The date that the package was (or will be) shippped.  ShipEngine will take the day of week into consideration. For example, if the carrier does not operate on Sundays, then a package that would have shipped on Sunday will ship on Monday instead. 
+    attr_accessor :ship_date
+
+    # The date and time that the label was created in ShipEngine.
+    attr_accessor :created_at
+
+    # The cost of shipping, delivery confirmation, and other carrier charges.  This amount **does not** include insurance costs. 
+    attr_accessor :shipment_cost
+
+    # The insurance cost for this package.  Add this to the `shipment_cost` field to get the total cost. 
+    attr_accessor :insurance_cost
+
+    # The tracking number for the package. Tracking number formats vary across carriers.
+    attr_accessor :tracking_number
+
+    # Indicates whether this is a return label.  You may also want to set the `rma_number` so you know what is being returned. 
+    attr_accessor :is_return_label
+
+    # An optional Return Merchandise Authorization number.  This field is useful for return labels.  You can set it to any string value. 
+    attr_accessor :rma_number
+
+    # Indicates whether this is an international shipment.  That is, the originating country and destination country are different. 
+    attr_accessor :is_international
+
+    # If this label was created as part of a [batch](https://www.shipengine.com/docs/labels/bulk/), then this is the unique ID of that batch. 
+    attr_accessor :batch_id
+
+    # The unique ID of the [carrier account](https://www.shipengine.com/docs/carriers/setup/) that was used to create this label 
+    attr_accessor :carrier_id
+
+    # The label charge event. 
+    attr_accessor :charge_event
+
+    # The `label_id` of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers. 
+    attr_accessor :outbound_label_id
+
+    # The [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/) used to ship the package, such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc. 
+    attr_accessor :service_code
+
+    # Indicate if this label is being used only for testing purposes. If true, then no charge will be added to your account.
+    attr_accessor :test_label
+
+    # The [package type](https://www.shipengine.com/docs/reference/list-carrier-packages/), such as `thick_envelope`, `small_flat_rate_box`, `large_package`, etc.  The code `package` indicates a custom or unknown package type. 
+    attr_accessor :package_code
+
+    attr_accessor :validate_address
+
+    # Indicates whether the label has been [voided](https://www.shipengine.com/docs/labels/voiding/) 
+    attr_accessor :voided
+
+    # The date and time that the label was [voided](https://www.shipengine.com/docs/labels/voiding/), or `null` if the label has not been voided 
+    attr_accessor :voided_at
+
+    attr_accessor :label_download_type
+
+    # The file format that you want the label to be in.  We recommend `pdf` format because it is supported by all carriers, whereas some carriers do not support the `png` or `zpl` formats. 
+    attr_accessor :label_format
+
+    # The layout (size) that you want the label to be in.  The `label_format` determines which sizes are allowed.  `4x6` is supported for all label formats, whereas `letter` (8.5\" x 11\") is only supported for `pdf` format. 
+    attr_accessor :label_layout
+
+    # Indicates whether the shipment is trackable, in which case the `tracking_status` field will reflect the current status and each package will have a `tracking_number`. 
+    attr_accessor :trackable
+
+    # The label image resource that was used to create a custom label image.
+    attr_accessor :label_image_id
+
+    # The [shipping carrier](https://www.shipengine.com/docs/carriers/setup/) who will ship the package, such as `fedex`, `dhl_express`, `stamps_com`, etc. 
+    attr_accessor :carrier_code
+
+    # The current status of the package, such as `in_transit` or `delivered`
+    attr_accessor :tracking_status
+
+    attr_accessor :label_download
+
+    # The link to downlaod the customs form (a.k.a. commercial invoice) for this shipment, if any.  Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it. 
+    attr_accessor :form_download
+
+    # The link to submit an insurance claim for the shipment.  This field is null if the shipment is not insured or if the insurance provider does not support online claim submission. 
+    attr_accessor :insurance_claim
+
+    # The label's package(s).  > **Note:** Some carriers only allow one package per label.  If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned. 
+    attr_accessor :packages
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'label_id' => :'label_id',
+        :'status' => :'status',
+        :'shipment_id' => :'shipment_id',
+        :'shipment' => :'shipment',
+        :'ship_date' => :'ship_date',
+        :'created_at' => :'created_at',
+        :'shipment_cost' => :'shipment_cost',
+        :'insurance_cost' => :'insurance_cost',
+        :'tracking_number' => :'tracking_number',
+        :'is_return_label' => :'is_return_label',
+        :'rma_number' => :'rma_number',
+        :'is_international' => :'is_international',
+        :'batch_id' => :'batch_id',
+        :'carrier_id' => :'carrier_id',
+        :'charge_event' => :'charge_event',
+        :'outbound_label_id' => :'outbound_label_id',
+        :'service_code' => :'service_code',
+        :'test_label' => :'test_label',
+        :'package_code' => :'package_code',
+        :'validate_address' => :'validate_address',
+        :'voided' => :'voided',
+        :'voided_at' => :'voided_at',
+        :'label_download_type' => :'label_download_type',
+        :'label_format' => :'label_format',
+        :'label_layout' => :'label_layout',
+        :'trackable' => :'trackable',
+        :'label_image_id' => :'label_image_id',
+        :'carrier_code' => :'carrier_code',
+        :'tracking_status' => :'tracking_status',
+        :'label_download' => :'label_download',
+        :'form_download' => :'form_download',
+        :'insurance_claim' => :'insurance_claim',
+        :'packages' => :'packages'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'label_id' => :'String',
+        :'status' => :'LabelStatus',
+        :'shipment_id' => :'String',
+        :'shipment' => :'Shipment',
+        :'ship_date' => :'DateTime',
+        :'created_at' => :'DateTime',
+        :'shipment_cost' => :'MonetaryValue',
+        :'insurance_cost' => :'MonetaryValue',
+        :'tracking_number' => :'String',
+        :'is_return_label' => :'Boolean',
+        :'rma_number' => :'String',
+        :'is_international' => :'Boolean',
+        :'batch_id' => :'String',
+        :'carrier_id' => :'String',
+        :'charge_event' => :'LabelChargeEvent',
+        :'outbound_label_id' => :'String',
+        :'service_code' => :'String',
+        :'test_label' => :'Boolean',
+        :'package_code' => :'String',
+        :'validate_address' => :'ValidateAddress',
+        :'voided' => :'Boolean',
+        :'voided_at' => :'DateTime',
+        :'label_download_type' => :'LabelDownloadType',
+        :'label_format' => :'LabelFormat',
+        :'label_layout' => :'LabelLayout',
+        :'trackable' => :'Boolean',
+        :'label_image_id' => :'String',
+        :'carrier_code' => :'String',
+        :'tracking_status' => :'TrackingStatus',
+        :'label_download' => :'LabelDownload',
+        :'form_download' => :'Link',
+        :'insurance_claim' => :'Link',
+        :'packages' => :'Array<Package>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'rma_number',
+        :'voided_at',
+        :'label_image_id',
+        :'form_download',
+        :'insurance_claim',
+      ])
+    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 `OpenapiClient::Label` 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 `OpenapiClient::Label`. 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?(:'label_id')
+        self.label_id = attributes[:'label_id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'shipment_id')
+        self.shipment_id = attributes[:'shipment_id']
+      end
+
+      if attributes.key?(:'shipment')
+        self.shipment = attributes[:'shipment']
+      end
+
+      if attributes.key?(:'ship_date')
+        self.ship_date = attributes[:'ship_date']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'shipment_cost')
+        self.shipment_cost = attributes[:'shipment_cost']
+      end
+
+      if attributes.key?(:'insurance_cost')
+        self.insurance_cost = attributes[:'insurance_cost']
+      end
+
+      if attributes.key?(:'tracking_number')
+        self.tracking_number = attributes[:'tracking_number']
+      end
+
+      if attributes.key?(:'is_return_label')
+        self.is_return_label = attributes[:'is_return_label']
+      end
+
+      if attributes.key?(:'rma_number')
+        self.rma_number = attributes[:'rma_number']
+      end
+
+      if attributes.key?(:'is_international')
+        self.is_international = attributes[:'is_international']
+      end
+
+      if attributes.key?(:'batch_id')
+        self.batch_id = attributes[:'batch_id']
+      end
+
+      if attributes.key?(:'carrier_id')
+        self.carrier_id = attributes[:'carrier_id']
+      end
+
+      if attributes.key?(:'charge_event')
+        self.charge_event = attributes[:'charge_event']
+      end
+
+      if attributes.key?(:'outbound_label_id')
+        self.outbound_label_id = attributes[:'outbound_label_id']
+      end
+
+      if attributes.key?(:'service_code')
+        self.service_code = attributes[:'service_code']
+      end
+
+      if attributes.key?(:'test_label')
+        self.test_label = attributes[:'test_label']
+      else
+        self.test_label = false
+      end
+
+      if attributes.key?(:'package_code')
+        self.package_code = attributes[:'package_code']
+      end
+
+      if attributes.key?(:'validate_address')
+        self.validate_address = attributes[:'validate_address']
+      end
+
+      if attributes.key?(:'voided')
+        self.voided = attributes[:'voided']
+      end
+
+      if attributes.key?(:'voided_at')
+        self.voided_at = attributes[:'voided_at']
+      end
+
+      if attributes.key?(:'label_download_type')
+        self.label_download_type = attributes[:'label_download_type']
+      end
+
+      if attributes.key?(:'label_format')
+        self.label_format = attributes[:'label_format']
+      end
+
+      if attributes.key?(:'label_layout')
+        self.label_layout = attributes[:'label_layout']
+      end
+
+      if attributes.key?(:'trackable')
+        self.trackable = attributes[:'trackable']
+      end
+
+      if attributes.key?(:'label_image_id')
+        self.label_image_id = attributes[:'label_image_id']
+      end
+
+      if attributes.key?(:'carrier_code')
+        self.carrier_code = attributes[:'carrier_code']
+      end
+
+      if attributes.key?(:'tracking_status')
+        self.tracking_status = attributes[:'tracking_status']
+      end
+
+      if attributes.key?(:'label_download')
+        self.label_download = attributes[:'label_download']
+      end
+
+      if attributes.key?(:'form_download')
+        self.form_download = attributes[:'form_download']
+      end
+
+      if attributes.key?(:'insurance_claim')
+        self.insurance_claim = attributes[:'insurance_claim']
+      end
+
+      if attributes.key?(:'packages')
+        if (value = attributes[:'packages']).is_a?(Array)
+          self.packages = 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
+      invalid_properties = Array.new
+      if !@tracking_number.nil? && @tracking_number.to_s.length < 1
+        invalid_properties.push('invalid value for "tracking_number", the character length must be great 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?
+      return false if !@tracking_number.nil? && @tracking_number.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tracking_number Value to be assigned
+    def tracking_number=(tracking_number)
+      if !tracking_number.nil? && tracking_number.to_s.length < 1
+        fail ArgumentError, 'invalid value for "tracking_number", the character length must be great than or equal to 1.'
+      end
+
+      @tracking_number = tracking_number
+    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 &&
+          label_id == o.label_id &&
+          status == o.status &&
+          shipment_id == o.shipment_id &&
+          shipment == o.shipment &&
+          ship_date == o.ship_date &&
+          created_at == o.created_at &&
+          shipment_cost == o.shipment_cost &&
+          insurance_cost == o.insurance_cost &&
+          tracking_number == o.tracking_number &&
+          is_return_label == o.is_return_label &&
+          rma_number == o.rma_number &&
+          is_international == o.is_international &&
+          batch_id == o.batch_id &&
+          carrier_id == o.carrier_id &&
+          charge_event == o.charge_event &&
+          outbound_label_id == o.outbound_label_id &&
+          service_code == o.service_code &&
+          test_label == o.test_label &&
+          package_code == o.package_code &&
+          validate_address == o.validate_address &&
+          voided == o.voided &&
+          voided_at == o.voided_at &&
+          label_download_type == o.label_download_type &&
+          label_format == o.label_format &&
+          label_layout == o.label_layout &&
+          trackable == o.trackable &&
+          label_image_id == o.label_image_id &&
+          carrier_code == o.carrier_code &&
+          tracking_status == o.tracking_status &&
+          label_download == o.label_download &&
+          form_download == o.form_download &&
+          insurance_claim == o.insurance_claim &&
+          packages == o.packages
+    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
+      [label_id, status, shipment_id, shipment, ship_date, created_at, shipment_cost, insurance_cost, tracking_number, is_return_label, rma_number, is_international, batch_id, carrier_id, charge_event, outbound_label_id, service_code, test_label, package_code, validate_address, voided, voided_at, label_download_type, label_format, label_layout, trackable, label_image_id, carrier_code, tracking_status, label_download, form_download, insurance_claim, packages].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)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        OpenapiClient.const_get(type).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)
+        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