zippendo 1.0.0

data/lib/zippendo/models/verify_api_token200_response.rb

@@ -0,0 +1,218 @@
+=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 VerifyApiToken200Response < ApiModelBase
+    # Whether the token is valid
+    attr_accessor :valid
+
+    # Token identifier
+    attr_accessor :token_id
+
+    # User identifier the token belongs to
+    attr_accessor :user_id
+
+    # Organization identifier the token belongs to
+    attr_accessor :org_id
+
+    # Permission scopes granted by the token
+    attr_accessor :scopes
+
+    # Expiry timestamp (ISO 8601), null if it never expires
+    attr_accessor :expires_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'valid' => :'valid',
+        :'token_id' => :'tokenId',
+        :'user_id' => :'userId',
+        :'org_id' => :'orgId',
+        :'scopes' => :'scopes',
+        :'expires_at' => :'expiresAt'
+      }
+    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
+      {
+        :'valid' => :'Boolean',
+        :'token_id' => :'String',
+        :'user_id' => :'String',
+        :'org_id' => :'String',
+        :'scopes' => :'Array<String>',
+        :'expires_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'expires_at'
+      ])
+    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::VerifyApiToken200Response` 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::VerifyApiToken200Response`. 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?(:'valid')
+        self.valid = attributes[:'valid']
+      else
+        self.valid = nil
+      end
+
+      if attributes.key?(:'token_id')
+        self.token_id = attributes[:'token_id']
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      end
+
+      if attributes.key?(:'org_id')
+        self.org_id = attributes[:'org_id']
+      end
+
+      if attributes.key?(:'scopes')
+        if (value = attributes[:'scopes']).is_a?(Array)
+          self.scopes = value
+        end
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      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 @valid.nil?
+        invalid_properties.push('invalid value for "valid", valid 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 @valid.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] valid Value to be assigned
+    def valid=(valid)
+      if valid.nil?
+        fail ArgumentError, 'valid cannot be nil'
+      end
+
+      @valid = valid
+    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 &&
+          valid == o.valid &&
+          token_id == o.token_id &&
+          user_id == o.user_id &&
+          org_id == o.org_id &&
+          scopes == o.scopes &&
+          expires_at == o.expires_at
+    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
+      [valid, token_id, user_id, org_id, scopes, expires_at].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/verify_api_token_request.rb

@@ -0,0 +1,165 @@
+=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 VerifyApiTokenRequest < ApiModelBase
+    # The API token to verify
+    attr_accessor :token
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'token' => :'token'
+      }
+    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
+      {
+        :'token' => :'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::VerifyApiTokenRequest` 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::VerifyApiTokenRequest`. 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?(:'token')
+        self.token = attributes[:'token']
+      else
+        self.token = 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 @token.nil?
+        invalid_properties.push('invalid value for "token", token 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 @token.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] token Value to be assigned
+    def token=(token)
+      if token.nil?
+        fail ArgumentError, 'token cannot be nil'
+      end
+
+      @token = token
+    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 &&
+          token == o.token
+    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
+      [token].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/version.rb

@@ -0,0 +1,15 @@
+=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
+
+module Zippendo
+  VERSION = '1.0.0'
+end

data/lib/zippendo.rb

@@ -0,0 +1,195 @@
+=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
+
+# Common files
+require 'zippendo/api_client'
+require 'zippendo/api_error'
+require 'zippendo/api_model_base'
+require 'zippendo/version'
+require 'zippendo/configuration'
+
+# Models
+require 'zippendo/models/batch_send_shipments200_response'
+require 'zippendo/models/batch_send_shipments200_response_results_inner'
+require 'zippendo/models/batch_send_shipments200_response_summary'
+require 'zippendo/models/batch_send_shipments_request'
+require 'zippendo/models/batch_split_shipment201_response'
+require 'zippendo/models/batch_split_shipment_request'
+require 'zippendo/models/batch_split_shipment_request_shipments_inner'
+require 'zippendo/models/batch_split_shipment_request_shipments_inner_order_lines_inner'
+require 'zippendo/models/connect_carrier_request'
+require 'zippendo/models/create_address_request'
+require 'zippendo/models/create_api_token201_response'
+require 'zippendo/models/create_api_token_request'
+require 'zippendo/models/create_order201_response'
+require 'zippendo/models/create_order201_response_order_lines_inner'
+require 'zippendo/models/create_order201_response_shipping_address'
+require 'zippendo/models/create_order_request'
+require 'zippendo/models/create_order_request_order_lines_inner'
+require 'zippendo/models/create_order_request_shipping_address'
+require 'zippendo/models/create_org_webhook201_response'
+require 'zippendo/models/create_org_webhook_request'
+require 'zippendo/models/create_shipment201_response'
+require 'zippendo/models/create_shipment201_response_activities_inner'
+require 'zippendo/models/create_shipment201_response_documents_inner'
+require 'zippendo/models/create_shipment201_response_errors_inner'
+require 'zippendo/models/create_shipment201_response_logs_inner'
+require 'zippendo/models/create_shipment201_response_parcels_inner'
+require 'zippendo/models/create_shipment201_response_parcels_inner_dimensions'
+require 'zippendo/models/create_shipment201_response_parcels_inner_order_lines_inner'
+require 'zippendo/models/create_shipment201_response_parties_inner'
+require 'zippendo/models/create_shipment201_response_parties_inner_attributes_inner'
+require 'zippendo/models/create_shipment201_response_pickup_details'
+require 'zippendo/models/create_shipment201_response_shipping_rule'
+require 'zippendo/models/create_shipment201_response_tracking'
+require 'zippendo/models/create_shipment_request'
+require 'zippendo/models/create_shipment_request_carrier_settings'
+require 'zippendo/models/create_shipment_request_parcels_inner'
+require 'zippendo/models/create_shipment_request_parcels_inner_dimensions'
+require 'zippendo/models/create_shipment_request_parcels_inner_order_lines_inner'
+require 'zippendo/models/create_shipment_request_parties_inner'
+require 'zippendo/models/create_shipment_request_parties_inner_attributes_inner'
+require 'zippendo/models/create_shipment_request_pickup_details'
+require 'zippendo/models/create_shipping_quote200_response'
+require 'zippendo/models/create_shipping_quote200_response_rates_inner'
+require 'zippendo/models/create_shipping_quote400_response'
+require 'zippendo/models/create_shipping_quote404_response'
+require 'zippendo/models/create_shipping_quote_request'
+require 'zippendo/models/create_shipping_quote_request_destination'
+require 'zippendo/models/create_shipping_quote_request_items_inner'
+require 'zippendo/models/create_shipping_rule201_response'
+require 'zippendo/models/create_shipping_rule_request'
+require 'zippendo/models/create_shipping_rule_request_additional_parameters'
+require 'zippendo/models/create_shipping_rule_request_additional_parameters_any_of_inner'
+require 'zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value'
+require 'zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of'
+require 'zippendo/models/create_shipping_rule_request_additional_parameters_any_of_value_any_of_coordinates_inner'
+require 'zippendo/models/create_shipping_rule_request_conditions_inner'
+require 'zippendo/models/create_shipping_rule_request_conditions_inner_one_of'
+require 'zippendo/models/create_shipping_rule_request_conditions_inner_one_of1'
+require 'zippendo/models/create_shipping_rule_request_conditions_inner_one_of2'
+require 'zippendo/models/create_shipping_rule_request_conditions_inner_one_of3'
+require 'zippendo/models/create_shipping_rule_request_conditions_inner_one_of4'
+require 'zippendo/models/delete_org_webhook200_response'
+require 'zippendo/models/delete_shipping_rule200_response'
+require 'zippendo/models/get_billing_usage200_response'
+require 'zippendo/models/get_billing_usage200_response_add_ons_inner'
+require 'zippendo/models/get_billing_usage200_response_current_period'
+require 'zippendo/models/get_billing_usage200_response_limits'
+require 'zippendo/models/get_billing_usage200_response_limits_team_members'
+require 'zippendo/models/get_billing_usage200_response_shipments'
+require 'zippendo/models/get_order200_response'
+require 'zippendo/models/get_order200_response_shipments_inner'
+require 'zippendo/models/get_order200_response_shipping_rule'
+require 'zippendo/models/get_org200_response'
+require 'zippendo/models/get_org200_response_count'
+require 'zippendo/models/get_org_branding200_response'
+require 'zippendo/models/health_check200_response'
+require 'zippendo/models/list_addresses200_response'
+require 'zippendo/models/list_addresses200_response_data_inner'
+require 'zippendo/models/list_api_tokens200_response'
+require 'zippendo/models/list_api_tokens200_response_data_inner'
+require 'zippendo/models/list_api_tokens200_response_data_inner_created_by'
+require 'zippendo/models/list_api_tokens401_response'
+require 'zippendo/models/list_available_carriers200_response_inner'
+require 'zippendo/models/list_available_carriers200_response_inner_required_fields_inner'
+require 'zippendo/models/list_carrier_product_service_points200_response_inner'
+require 'zippendo/models/list_carrier_product_service_points200_response_inner_address'
+require 'zippendo/models/list_carrier_product_service_points_request'
+require 'zippendo/models/list_carrier_products200_response_inner'
+require 'zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner'
+require 'zippendo/models/list_carrier_products200_response_inner_additional_parameters_inner_options_inner'
+require 'zippendo/models/list_carrier_products200_response_inner_services_inner'
+require 'zippendo/models/list_carrier_products200_response_inner_weight_limits'
+require 'zippendo/models/list_carriers200_response'
+require 'zippendo/models/list_carriers200_response_data_inner'
+require 'zippendo/models/list_carriers200_response_data_inner_config_value'
+require 'zippendo/models/list_orders200_response'
+require 'zippendo/models/list_orders200_response_data_inner'
+require 'zippendo/models/list_orders200_response_data_inner_order_channel'
+require 'zippendo/models/list_org_webhook_deliveries200_response'
+require 'zippendo/models/list_org_webhook_deliveries200_response_data_inner'
+require 'zippendo/models/list_org_webhooks200_response'
+require 'zippendo/models/list_org_webhooks200_response_data_inner'
+require 'zippendo/models/list_shipments200_response'
+require 'zippendo/models/list_shipments200_response_data_inner'
+require 'zippendo/models/list_shipments200_response_data_inner_address'
+require 'zippendo/models/list_shipments200_response_data_inner_carrier_settings'
+require 'zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value'
+require 'zippendo/models/list_shipments200_response_data_inner_carrier_settings_additional_parameters_value_any_of'
+require 'zippendo/models/list_shipping_rules200_response'
+require 'zippendo/models/list_shipping_rules200_response_data_inner'
+require 'zippendo/models/list_shipping_rules200_response_data_inner_additional_parameters_inner'
+require 'zippendo/models/list_shipping_rules200_response_data_inner_carrier'
+require 'zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner'
+require 'zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of'
+require 'zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of1'
+require 'zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of2'
+require 'zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of3'
+require 'zippendo/models/list_shipping_rules200_response_data_inner_conditions_inner_one_of4'
+require 'zippendo/models/list_shipping_rules200_response_data_inner_label_printer'
+require 'zippendo/models/list_shipping_rules200_response_data_inner_return_shipping_rule'
+require 'zippendo/models/revoke_api_token200_response'
+require 'zippendo/models/send_shipment422_response'
+require 'zippendo/models/send_shipment422_response_errors_inner'
+require 'zippendo/models/split_shipment201_response'
+require 'zippendo/models/split_shipment_parcel200_response'
+require 'zippendo/models/split_shipment_parcel_request'
+require 'zippendo/models/split_shipment_parcel_request_parcels_inner'
+require 'zippendo/models/split_shipment_request'
+require 'zippendo/models/test_org_webhook200_response'
+require 'zippendo/models/track_shipment200_response'
+require 'zippendo/models/track_shipment200_response_events_inner'
+require 'zippendo/models/update_address_request'
+require 'zippendo/models/update_api_token_request'
+require 'zippendo/models/update_carrier_request'
+require 'zippendo/models/update_order_request'
+require 'zippendo/models/update_org200_response'
+require 'zippendo/models/update_org_branding_request'
+require 'zippendo/models/update_org_request'
+require 'zippendo/models/update_org_webhook_request'
+require 'zippendo/models/update_shipment_request'
+require 'zippendo/models/update_shipping_rule_request'
+require 'zippendo/models/verify_api_token200_response'
+require 'zippendo/models/verify_api_token_request'
+
+# APIs
+require 'zippendo/api/addresses_api'
+require 'zippendo/api/billing_api'
+require 'zippendo/api/carrier_catalog_api'
+require 'zippendo/api/carriers_api'
+require 'zippendo/api/orders_api'
+require 'zippendo/api/orgs_api'
+require 'zippendo/api/quotes_api'
+require 'zippendo/api/rules_api'
+require 'zippendo/api/shipments_api'
+require 'zippendo/api/system_api'
+require 'zippendo/api/tokens_api'
+require 'zippendo/api/webhooks_api'
+
+module Zippendo
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Zippendo.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end