timelogic-api 1.1.0 → 2.0.0

data/lib/timelogic-api/models/timezone_match.rb

@@ -14,48 +14,21 @@ require 'date'
 require 'time'
 
 module TimeLogic::Api
+  # One geographic zone whose current offset equals the requested offset.
   class TimezoneMatch
-    attr_accessor :unix
-
-    attr_accessor :unix_ms
-
-    attr_accessor :utc
-
-    attr_accessor :iso_local
-
-    attr_accessor :rfc2822
-
-    attr_accessor :human
-
-    # Day of the week counted from Sunday (1 = Sunday, 2 = Monday ... 7 = Saturday).
-    attr_accessor :day_number
-
-    attr_accessor :day_short
-
-    attr_accessor :day_full
-
+    # IANA timezone name.
     attr_accessor :timezone
 
-    attr_accessor :formatted
-
+    # Current UTC offset of the zone in minutes.
     attr_accessor :offset
 
+    # Whether daylight saving time is currently in effect in the zone.
     attr_accessor :dst
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'unix' => :'unix',
-        :'unix_ms' => :'unix_ms',
-        :'utc' => :'utc',
-        :'iso_local' => :'iso_local',
-        :'rfc2822' => :'rfc2822',
-        :'human' => :'human',
-        :'day_number' => :'day_number',
-        :'day_short' => :'day_short',
-        :'day_full' => :'day_full',
         :'timezone' => :'timezone',
-        :'formatted' => :'formatted',
         :'offset' => :'offset',
         :'dst' => :'dst'
       }
@@ -69,17 +42,7 @@ module TimeLogic::Api
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'unix' => :'Integer',
-        :'unix_ms' => :'Integer',
-        :'utc' => :'Time',
-        :'iso_local' => :'String',
-        :'rfc2822' => :'String',
-        :'human' => :'String',
-        :'day_number' => :'Integer',
-        :'day_short' => :'String',
-        :'day_full' => :'String',
         :'timezone' => :'String',
-        :'formatted' => :'String',
         :'offset' => :'Integer',
         :'dst' => :'Boolean'
       }
@@ -88,17 +51,9 @@ module TimeLogic::Api
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'iso_local',
       ])
     end
 
-    # List of class defined in allOf (OpenAPI v3)
-    def self.openapi_all_of
-      [
-      :'TimePayload'
-      ]
-    end
-
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -114,70 +69,12 @@ module TimeLogic::Api
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'unix')
-        self.unix = attributes[:'unix']
-      else
-        self.unix = nil
-      end
-
-      if attributes.key?(:'unix_ms')
-        self.unix_ms = attributes[:'unix_ms']
-      else
-        self.unix_ms = nil
-      end
-
-      if attributes.key?(:'utc')
-        self.utc = attributes[:'utc']
-      else
-        self.utc = nil
-      end
-
-      if attributes.key?(:'iso_local')
-        self.iso_local = attributes[:'iso_local']
-      else
-        self.iso_local = nil
-      end
-
-      if attributes.key?(:'rfc2822')
-        self.rfc2822 = attributes[:'rfc2822']
-      else
-        self.rfc2822 = nil
-      end
-
-      if attributes.key?(:'human')
-        self.human = attributes[:'human']
-      else
-        self.human = nil
-      end
-
-      if attributes.key?(:'day_number')
-        self.day_number = attributes[:'day_number']
-      else
-        self.day_number = nil
-      end
-
-      if attributes.key?(:'day_short')
-        self.day_short = attributes[:'day_short']
-      else
-        self.day_short = nil
-      end
-
-      if attributes.key?(:'day_full')
-        self.day_full = attributes[:'day_full']
-      else
-        self.day_full = nil
-      end
-
       if attributes.key?(:'timezone')
         self.timezone = attributes[:'timezone']
       else
         self.timezone = nil
       end
 
-      if attributes.key?(:'formatted')
-        self.formatted = attributes[:'formatted']
-      end
-
       if attributes.key?(:'offset')
         self.offset = attributes[:'offset']
       else
@@ -196,46 +93,6 @@ module TimeLogic::Api
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @unix.nil?
-        invalid_properties.push('invalid value for "unix", unix cannot be nil.')
-      end
-
-      if @unix_ms.nil?
-        invalid_properties.push('invalid value for "unix_ms", unix_ms cannot be nil.')
-      end
-
-      if @utc.nil?
-        invalid_properties.push('invalid value for "utc", utc cannot be nil.')
-      end
-
-      if @rfc2822.nil?
-        invalid_properties.push('invalid value for "rfc2822", rfc2822 cannot be nil.')
-      end
-
-      if @human.nil?
-        invalid_properties.push('invalid value for "human", human cannot be nil.')
-      end
-
-      if @day_number.nil?
-        invalid_properties.push('invalid value for "day_number", day_number cannot be nil.')
-      end
-
-      if @day_number > 7
-        invalid_properties.push('invalid value for "day_number", must be smaller than or equal to 7.')
-      end
-
-      if @day_number < 1
-        invalid_properties.push('invalid value for "day_number", must be greater than or equal to 1.')
-      end
-
-      if @day_short.nil?
-        invalid_properties.push('invalid value for "day_short", day_short cannot be nil.')
-      end
-
-      if @day_full.nil?
-        invalid_properties.push('invalid value for "day_full", day_full cannot be nil.')
-      end
-
       if @timezone.nil?
         invalid_properties.push('invalid value for "timezone", timezone cannot be nil.')
       end
@@ -255,56 +112,18 @@ module TimeLogic::Api
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @unix.nil?
-      return false if @unix_ms.nil?
-      return false if @utc.nil?
-      return false if @rfc2822.nil?
-      return false if @human.nil?
-      return false if @day_number.nil?
-      return false if @day_number > 7
-      return false if @day_number < 1
-      return false if @day_short.nil?
-      return false if @day_full.nil?
       return false if @timezone.nil?
       return false if @offset.nil?
       return false if @dst.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] day_number Value to be assigned
-    def day_number=(day_number)
-      if day_number.nil?
-        fail ArgumentError, 'day_number cannot be nil'
-      end
-
-      if day_number > 7
-        fail ArgumentError, 'invalid value for "day_number", must be smaller than or equal to 7.'
-      end
-
-      if day_number < 1
-        fail ArgumentError, 'invalid value for "day_number", must be greater than or equal to 1.'
-      end
-
-      @day_number = day_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 &&
-          unix == o.unix &&
-          unix_ms == o.unix_ms &&
-          utc == o.utc &&
-          iso_local == o.iso_local &&
-          rfc2822 == o.rfc2822 &&
-          human == o.human &&
-          day_number == o.day_number &&
-          day_short == o.day_short &&
-          day_full == o.day_full &&
           timezone == o.timezone &&
-          formatted == o.formatted &&
           offset == o.offset &&
           dst == o.dst
     end
@@ -318,7 +137,7 @@ module TimeLogic::Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [unix, unix_ms, utc, iso_local, rfc2822, human, day_number, day_short, day_full, timezone, formatted, offset, dst].hash
+      [timezone, offset, dst].hash
     end
 
     # Builds the object from hash

data/lib/timelogic-api/models/{timezone_offset_response.rb → timezone_response.rb}

@@ -14,8 +14,8 @@ require 'date'
 require 'time'
 
 module TimeLogic::Api
-  # Offset-based timezone lookup result with `matching_zones` for the current request-time offset match.
-  class TimezoneOffsetResponse
+  # Timezone lookup result. It is the time payload for the resolved target plus `offset` (minutes east of UTC) and `dst`.  Every selector returns this one shape. `tz`, `ip`, `lat` + `lon` and `auto_tz` lookups resolve a named zone, so `timezone` is set and `matching_zones` is absent. `offset` lookups return `timezone=null` and add `matching_zones`, the geographic zones whose current offset equals the requested one.
+  class TimezoneResponse
     attr_accessor :unix
 
     attr_accessor :unix_ms
@@ -39,11 +39,16 @@ module TimeLogic::Api
 
     attr_accessor :formatted
 
+    # UTC offset of the resolved target in minutes, for example `-240` for UTC-04:00.
     attr_accessor :offset
 
+    # Whether daylight saving time is in effect for the resolved target. Always `false` for `offset` lookups.
     attr_accessor :dst
 
-    # For `offset=` lookups, the geographic zones whose current offset equals the requested one. `UTC` and `Etc/*` zones are intentionally excluded; use `tz=UTC` for UTC.
+    # Exact UTC offset in seconds. Present only when the resolved offset has a seconds part (historical local mean time); no zone has one at the current instant, so lookups today do not include it.
+    attr_accessor :offset_seconds
+
+    # Present only for `offset=` lookups. The geographic zones whose current offset equals the requested one. `UTC` and `Etc/*` zones are intentionally excluded; use `tz=UTC` for UTC.
     attr_accessor :matching_zones
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -62,6 +67,7 @@ module TimeLogic::Api
         :'formatted' => :'formatted',
         :'offset' => :'offset',
         :'dst' => :'dst',
+        :'offset_seconds' => :'offset_seconds',
         :'matching_zones' => :'matching_zones'
       }
     end
@@ -87,6 +93,7 @@ module TimeLogic::Api
         :'formatted' => :'String',
         :'offset' => :'Integer',
         :'dst' => :'Boolean',
+        :'offset_seconds' => :'Integer',
         :'matching_zones' => :'Array<TimezoneMatch>'
       }
     end
@@ -102,7 +109,7 @@ module TimeLogic::Api
     # List of class defined in allOf (OpenAPI v3)
     def self.openapi_all_of
       [
-      :'TimezoneResolvedResponse'
+      :'TimePayload'
       ]
     end
 
@@ -110,13 +117,13 @@ module TimeLogic::Api
     # @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 `TimeLogic::Api::TimezoneOffsetResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TimeLogic::Api::TimezoneResponse` 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 `TimeLogic::Api::TimezoneOffsetResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TimeLogic::Api::TimezoneResponse`. 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
       }
@@ -197,12 +204,14 @@ module TimeLogic::Api
         self.dst = nil
       end
 
+      if attributes.key?(:'offset_seconds')
+        self.offset_seconds = attributes[:'offset_seconds']
+      end
+
       if attributes.key?(:'matching_zones')
         if (value = attributes[:'matching_zones']).is_a?(Array)
           self.matching_zones = value
         end
-      else
-        self.matching_zones = nil
       end
     end
 
@@ -259,10 +268,6 @@ module TimeLogic::Api
         invalid_properties.push('invalid value for "dst", dst cannot be nil.')
       end
 
-      if @matching_zones.nil?
-        invalid_properties.push('invalid value for "matching_zones", matching_zones cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -282,7 +287,6 @@ module TimeLogic::Api
       return false if @day_full.nil?
       return false if @offset.nil?
       return false if @dst.nil?
-      return false if @matching_zones.nil?
       true
     end
 
@@ -322,6 +326,7 @@ module TimeLogic::Api
           formatted == o.formatted &&
           offset == o.offset &&
           dst == o.dst &&
+          offset_seconds == o.offset_seconds &&
           matching_zones == o.matching_zones
     end
 
@@ -334,7 +339,7 @@ module TimeLogic::Api
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [unix, unix_ms, utc, iso_local, rfc2822, human, day_number, day_short, day_full, timezone, formatted, offset, dst, matching_zones].hash
+      [unix, unix_ms, utc, iso_local, rfc2822, human, day_number, day_short, day_full, timezone, formatted, offset, dst, offset_seconds, matching_zones].hash
     end
 
     # Builds the object from hash

data/lib/timelogic-api/version.rb

@@ -2,6 +2,6 @@
 
 module TimeLogic
   module Api
-    VERSION = '1.1.0'
+    VERSION = '2.0.0'
   end
 end

data/lib/timelogic-api.rb

@@ -30,14 +30,12 @@ require 'timelogic-api/models/dst_response'
 require 'timelogic-api/models/elapsed_response'
 require 'timelogic-api/models/error_response'
 require 'timelogic-api/models/get_current_time200_response'
-require 'timelogic-api/models/get_timezone200_response'
 require 'timelogic-api/models/jwk_key'
 require 'timelogic-api/models/jwks_response'
 require 'timelogic-api/models/time_payload'
 require 'timelogic-api/models/time_payload_bulk_item'
 require 'timelogic-api/models/timezone_match'
-require 'timelogic-api/models/timezone_offset_response'
-require 'timelogic-api/models/timezone_resolved_response'
+require 'timelogic-api/models/timezone_response'
 require 'timelogic-api/models/time_payload_bulk_response'
 
 # APIs

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timelogic-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - TimeLogic API LLC
@@ -68,7 +68,6 @@ files:
 - docs/ElapsedResponse.md
 - docs/ErrorResponse.md
 - docs/GetCurrentTime200Response.md
-- docs/GetTimezone200Response.md
 - docs/JwkKey.md
 - docs/JwksResponse.md
 - docs/TimeApi.md
@@ -76,8 +75,7 @@ files:
 - docs/TimePayloadBulkItem.md
 - docs/TimePayloadBulkResponse.md
 - docs/TimezoneMatch.md
-- docs/TimezoneOffsetResponse.md
-- docs/TimezoneResolvedResponse.md
+- docs/TimezoneResponse.md
 - docs/UtilityApi.md
 - lib/timelogic-api.rb
 - lib/timelogic-api/api/time_api.rb
@@ -94,15 +92,13 @@ files:
 - lib/timelogic-api/models/elapsed_response.rb
 - lib/timelogic-api/models/error_response.rb
 - lib/timelogic-api/models/get_current_time200_response.rb
-- lib/timelogic-api/models/get_timezone200_response.rb
 - lib/timelogic-api/models/jwk_key.rb
 - lib/timelogic-api/models/jwks_response.rb
 - lib/timelogic-api/models/time_payload.rb
 - lib/timelogic-api/models/time_payload_bulk_item.rb
 - lib/timelogic-api/models/time_payload_bulk_response.rb
 - lib/timelogic-api/models/timezone_match.rb
-- lib/timelogic-api/models/timezone_offset_response.rb
-- lib/timelogic-api/models/timezone_resolved_response.rb
+- lib/timelogic-api/models/timezone_response.rb
 - lib/timelogic-api/transport_configuration.rb
 - lib/timelogic-api/version.rb
 - lib/timelogic-api/world_time_api.rb

data/docs/GetTimezone200Response.md

@@ -1,49 +0,0 @@
-# TimeLogic::Api::GetTimezone200Response
-
-## Class instance methods
-
-### `openapi_one_of`
-
-Returns the list of classes defined in oneOf.
-
-#### Example
-
-```ruby
-require 'timelogic-api'
-
-TimeLogic::Api::GetTimezone200Response.openapi_one_of
-# =>
-# [
-#   :'TimezoneOffsetResponse',
-#   :'TimezoneResolvedResponse'
-# ]
-```
-
-### build
-
-Find the appropriate object from the `openapi_one_of` list and casts the data into it.
-
-#### Example
-
-```ruby
-require 'timelogic-api'
-
-TimeLogic::Api::GetTimezone200Response.build(data)
-# => #<TimezoneOffsetResponse:0x00007fdd4aab02a0>
-
-TimeLogic::Api::GetTimezone200Response.build(data_that_doesnt_match)
-# => nil
-```
-
-#### Parameters
-
-| Name | Type | Description |
-| ---- | ---- | ----------- |
-| **data** | **Mixed** | data to be matched against the list of oneOf items |
-
-#### Return type
-
-- `TimezoneOffsetResponse`
-- `TimezoneResolvedResponse`
-- `nil` (if no type matches)
-

data/docs/TimezoneResolvedResponse.md

@@ -1,42 +0,0 @@
-# TimeLogic::Api::TimezoneResolvedResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **unix** | **Integer** |  |  |
-| **unix_ms** | **Integer** |  |  |
-| **utc** | **Time** |  |  |
-| **iso_local** | **String** |  |  |
-| **rfc2822** | **String** |  |  |
-| **human** | **String** |  |  |
-| **day_number** | **Integer** | Day of the week counted from Sunday (1 = Sunday, 2 = Monday ... 7 = Saturday). |  |
-| **day_short** | **String** |  |  |
-| **day_full** | **String** |  |  |
-| **timezone** | **String** |  |  |
-| **formatted** | **String** |  | [optional] |
-| **offset** | **Integer** |  |  |
-| **dst** | **Boolean** |  |  |
-
-## Example
-
-```ruby
-require 'timelogic-api'
-
-instance = TimeLogic::Api::TimezoneResolvedResponse.new(
-  unix: null,
-  unix_ms: null,
-  utc: null,
-  iso_local: null,
-  rfc2822: null,
-  human: null,
-  day_number: null,
-  day_short: null,
-  day_full: null,
-  timezone: null,
-  formatted: null,
-  offset: null,
-  dst: null
-)
-```
-

data/lib/timelogic-api/models/get_timezone200_response.rb

@@ -1,105 +0,0 @@
-=begin
-#TimeLogic API | A World Time API
-
-#Direct API contract for client integrations. It documents authentication, endpoint parameters, response shapes, public signing keys, and signed JSON controls.  Authentication: - the API supports `Authorization: Bearer <token>`, `X-API-Key`, and `api_key` query credentials - RapidAPI access uses `X-RapidAPI-Key` and `X-RapidAPI-Host`; the SDKs expose this as a `rapidApi` transport option that accepts only the RapidAPI key  Behavioral notes: - all documented operations are `GET` - only one selector family may be used at a time - current and convert support bulk only through one comma-separated `tz`, `ip`, or `offset` selector - bulk selectors accept at most 10 values, and every request URL is limited to 8192 characters - add, diff, calendar, dst, elapsed, timezone, and clock are single-target routes - credentials are extracted in Authorization, X-API-Key, then api_key query order; conflicting values are rejected - the first server is the default API host. The second server is the RapidAPI gateway and can be selected or overridden by SDK configuration - `sign` is available on supported JSON routes and is not supported on `/v1/time/clock`
-
-The version of the OpenAPI document: 1.0.0
-
-Generated by: https://github.com/TimeLogic-API-LLC/timelogic-api-sdks.git
-Generator version: 7.10.0
-
-=end
-
-require 'date'
-require 'time'
-
-module TimeLogic::Api
-  module GetTimezone200Response
-    class << self
-      # List of class defined in oneOf (OpenAPI v3)
-      def openapi_one_of
-        [
-          :'TimezoneOffsetResponse',
-          :'TimezoneResolvedResponse'
-        ]
-      end
-
-      # Builds the object
-      # @param [Mixed] Data to be matched against the list of oneOf items
-      # @return [Object] Returns the model or the data itself
-      def build(data)
-        # Go through the list of oneOf items and attempt to identify the appropriate one.
-        # Note:
-        # - We do not attempt to check whether exactly one item matches.
-        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
-        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
-        # - TODO: scalar values are de facto behaving as if they were nullable.
-        # - TODO: logging when debugging is set.
-        openapi_one_of.each do |klass|
-          begin
-            next if klass == :AnyType # "nullable: true"
-            typed_data = find_and_cast_into_type(klass, data)
-            return typed_data if typed_data
-          rescue # rescue all errors so we keep iterating even if the current item lookup raises
-          end
-        end
-
-        openapi_one_of.include?(:AnyType) ? data : nil
-      end
-
-      private
-
-      SchemaMismatchError = Class.new(StandardError)
-
-      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
-      def find_and_cast_into_type(klass, data)
-        return if data.nil?
-
-        case klass.to_s
-        when 'Boolean'
-          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
-        when 'Float'
-          return data if data.instance_of?(Float)
-        when 'Integer'
-          return data if data.instance_of?(Integer)
-        when 'Time'
-          return Time.parse(data)
-        when 'Date'
-          return Date.parse(data)
-        when 'String'
-          return data if data.instance_of?(String)
-        when 'Object' # "type: object"
-          return data if data.instance_of?(Hash)
-        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
-          if data.instance_of?(Array)
-            sub_type = Regexp.last_match[:sub_type]
-            return data.map { |item| find_and_cast_into_type(sub_type, item) }
-          end
-        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
-          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
-            sub_type = Regexp.last_match[:sub_type]
-            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
-          end
-        else # model
-          const = TimeLogic::Api.const_get(klass)
-          if const
-            if const.respond_to?(:openapi_one_of) # nested oneOf model
-              model = const.build(data)
-              return model if model
-            else
-              # raise if data contains keys that are not known to the model
-              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
-              model = const.build_from_hash(data)
-              return model if model
-            end
-          end
-        end
-
-        raise # if no match by now, raise
-      rescue
-        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
-      end
-    end
-  end
-
-end