timelogic-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bb2486a072e9b42e148c963e7484051e8b87cd4408924000739c24ad6461e31
+  data.tar.gz: bc0d507bfc4c7c759b30bbab2940151240c67b3fa99bf70350c80b35dc49c9b0
+SHA512:
+  metadata.gz: 68039138e4df8750915c19e9215dbea4dc58cc4f99f8b01d8ccfc6c9aaa1fec2459da95e8dce74adcbdaa9ec4a3f8129ef3633dda130cc4755ca46612037d92d
+  data.tar.gz: c34e8c55dec640210d14a5e86f78210eb10b971a64bd1eee9c8f3b75d5daa755f0cdeaaaac970d5403097882fdc00b6f77f17c20b3f5eb32ef72b7488d8d8887

data/README.md

@@ -0,0 +1,188 @@
+# TimeLogic API | A World Time API
+
+Official Ruby SDK for TimeLogic API, providing world time, timezone, calendar, and signed response operations.
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build timelogic-api.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./timelogic-api-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./timelogic-api-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'timelogic-api', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/TimeLogic-API-LLC/timelogic-api-sdks.git, then add the following in the Gemfile:
+
+    gem 'timelogic-api', :git => 'https://github.com/TimeLogic-API-LLC/timelogic-api-sdks.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'timelogic-api'
+
+# Setup authorization
+TimeLogic::Api.configure do |config|
+  # Configure API key authorization: directApiKeyHeader
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+
+  # Configure Bearer authorization (TimeLogic API key): directBearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure a proc to get access tokens in lieu of the static access_token configuration
+  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
+
+  # Configure API key authorization: directApiKeyQuery
+  config.api_key['api_key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['api_key'] = 'Bearer'
+
+  # Configure API key authorization: rapidApiKey
+  config.api_key['X-RapidAPI-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-RapidAPI-Key'] = 'Bearer'
+
+  # Configure API key authorization: rapidApiHost
+  config.api_key['X-RapidAPI-Host'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-RapidAPI-Host'] = 'Bearer'
+end
+
+api_instance = TimeLogic::Api::TimeApi.new
+opts = {
+  unix: 1711300000, # Integer | 
+  unix_ms: 1711300000000, # Integer | 
+  iso: '2024-03-24T15:00:00', # String | ISO-8601 timestamp. To supply a local wall-clock time without an explicit offset, pair it with one of `source_tz=Area/City`, `source_ip=...`, `source_lat=...&source_lon=...`, or `source_offset=±HH:MM`.
+  source_tz: 'America/New_York', # String | Used only with `iso=...` when the ISO value has no explicit offset.
+  source_ip: '8.8.8.8', # String | Used only with `iso=...` when the ISO value has no explicit offset. Resolves that local wall-clock time through the timezone mapped from this IP address.
+  source_lat: 40.7128, # Float | Used only with `iso=...` when the ISO value has no explicit offset. Provide together with `source_lon` to resolve that local wall-clock time through the timezone mapped from these coordinates.
+  source_lon: -74.006, # Float | Used only with `iso=...` when the ISO value has no explicit offset. Provide together with `source_lat`.
+  source_offset: '-05:00', # String | Used only with `iso=...` when the ISO value has no explicit offset. Interprets that local wall-clock time at this fixed UTC offset.
+  seconds: 30, # Integer | 
+  minutes: 15, # Integer | 
+  hours: 2, # Integer | 
+  days: 7, # Integer | 
+  tz: 'America/New_York', # String | IANA timezone name. On bulk-capable routes, a comma-separated list enables bulk mode.
+  ip: '8.8.8.8', # String | IP address. On bulk-capable routes, a comma-separated list enables bulk mode.
+  lat: 40.7128, # Float | Latitude. Must be provided together with `lon`.
+  lon: -74.006, # Float | Longitude. Must be provided together with `lat`.
+  offset: '-04:00', # String | Fixed UTC offset in `+HH:MM` or `-HH:MM` format. On bulk-capable routes, a comma-separated list enables bulk mode.
+  auto_tz: true, # Boolean | Set to `true` to resolve using the caller IP from Cloudflare headers.
+  utc: true, # Boolean | Set to `true` to force UTC on routes that support it.
+  format: '%Y-%m-%d %H:%M:%S', # String | Custom date/time format template using supported `strftime`-style directives such as `%Y-%m-%d %H:%M:%S`. Reference: [strftime](https://strftime.net/).
+  sign: true # Boolean | Set to exactly `true` to ask the gateway to sign the final JSON response. Every authenticated JSON response, including errors, then includes signing headers. Not supported on `/v1/time/clock`.
+}
+
+begin
+  #Add modifiers to a timestamp
+  result = api_instance.add_time(opts)
+  p result
+rescue TimeLogic::Api::ApiError => e
+  puts "Exception when calling TimeApi->add_time: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.timelogicapi.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*TimeLogic::Api::TimeApi* | [**add_time**](docs/TimeApi.md#add_time) | **GET** /v1/time/add | Add modifiers to a timestamp
+*TimeLogic::Api::TimeApi* | [**convert_time**](docs/TimeApi.md#convert_time) | **GET** /v1/time/convert | Convert a timestamp into a target timezone or offset
+*TimeLogic::Api::TimeApi* | [**diff_time**](docs/TimeApi.md#diff_time) | **GET** /v1/time/diff | Difference between two instants
+*TimeLogic::Api::TimeApi* | [**get_calendar**](docs/TimeApi.md#get_calendar) | **GET** /v1/time/calendar | Calendar projection for a target instant
+*TimeLogic::Api::TimeApi* | [**get_clock**](docs/TimeApi.md#get_clock) | **GET** /v1/time/clock | Render a live HTML clock
+*TimeLogic::Api::TimeApi* | [**get_current_time**](docs/TimeApi.md#get_current_time) | **GET** /v1/time/current | Get the current time for a target
+*TimeLogic::Api::TimeApi* | [**get_dst**](docs/TimeApi.md#get_dst) | **GET** /v1/time/dst | Daylight-saving status for a target
+*TimeLogic::Api::TimeApi* | [**get_elapsed**](docs/TimeApi.md#get_elapsed) | **GET** /v1/time/elapsed | Time elapsed since or remaining until a reference instant
+*TimeLogic::Api::TimeApi* | [**get_timezone**](docs/TimeApi.md#get_timezone) | **GET** /v1/timezone | Resolve timezone information for a target
+*TimeLogic::Api::UtilityApi* | [**get_public_signing_key**](docs/UtilityApi.md#get_public_signing_key) | **GET** /.well-known/time-api-public-key | Public signing key set
+
+
+## Documentation for Models
+
+ - [TimeLogic::Api::ApiError](docs/ApiError.md)
+ - [TimeLogic::Api::BulkError](docs/BulkError.md)
+ - [TimeLogic::Api::CalendarResponse](docs/CalendarResponse.md)
+ - [TimeLogic::Api::DiffEndpointRef](docs/DiffEndpointRef.md)
+ - [TimeLogic::Api::DiffResponse](docs/DiffResponse.md)
+ - [TimeLogic::Api::DstResponse](docs/DstResponse.md)
+ - [TimeLogic::Api::ElapsedResponse](docs/ElapsedResponse.md)
+ - [TimeLogic::Api::ErrorResponse](docs/ErrorResponse.md)
+ - [TimeLogic::Api::GetCurrentTime200Response](docs/GetCurrentTime200Response.md)
+ - [TimeLogic::Api::GetTimezone200Response](docs/GetTimezone200Response.md)
+ - [TimeLogic::Api::JwkKey](docs/JwkKey.md)
+ - [TimeLogic::Api::JwksResponse](docs/JwksResponse.md)
+ - [TimeLogic::Api::TimePayload](docs/TimePayload.md)
+ - [TimeLogic::Api::TimePayloadBulkItem](docs/TimePayloadBulkItem.md)
+ - [TimeLogic::Api::TimePayloadBulkResponse](docs/TimePayloadBulkResponse.md)
+ - [TimeLogic::Api::TimezoneMatch](docs/TimezoneMatch.md)
+ - [TimeLogic::Api::TimezoneOffsetResponse](docs/TimezoneOffsetResponse.md)
+ - [TimeLogic::Api::TimezoneResolvedResponse](docs/TimezoneResolvedResponse.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### directBearerAuth
+
+- **Type**: Bearer authentication (TimeLogic API key)
+
+### directApiKeyHeader
+
+
+- **Type**: API key
+- **API key parameter name**: X-API-Key
+- **Location**: HTTP header
+
+### directApiKeyQuery
+
+
+- **Type**: API key
+- **API key parameter name**: api_key
+- **Location**: URL query string
+
+### rapidApiKey
+
+
+- **Type**: API key
+- **API key parameter name**: X-RapidAPI-Key
+- **Location**: HTTP header
+
+### rapidApiHost
+
+
+- **Type**: API key
+- **API key parameter name**: X-RapidAPI-Host
+- **Location**: HTTP header

data/docs/ApiError.md

@@ -0,0 +1,22 @@
+# TimeLogic::Api::ApiError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **message** | **String** |  |  |
+| **details** | **Object** | Optional implementation-specific detail payload. | [optional] |
+
+## Example
+
+```ruby
+require 'timelogic-api'
+
+instance = TimeLogic::Api::ApiError.new(
+  code: null,
+  message: null,
+  details: null
+)
+```
+

data/docs/BulkError.md

@@ -0,0 +1,24 @@
+# TimeLogic::Api::BulkError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ApiError**](ApiError.md) |  |  |
+| **request_id** | **String** |  |  |
+| **timestamp** | **Time** | Intentionally omitted from public API error responses to avoid exposing request timing; use request_id for support correlation. | [optional] |
+| **item** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'timelogic-api'
+
+instance = TimeLogic::Api::BulkError.new(
+  error: null,
+  request_id: null,
+  timestamp: null,
+  item: null
+)
+```
+

data/docs/CalendarResponse.md

@@ -0,0 +1,48 @@
+# TimeLogic::Api::CalendarResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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** |  | [optional] |
+| **year** | **Integer** |  |  |
+| **month** | **Integer** |  |  |
+| **month_name** | **String** |  |  |
+| **day** | **Integer** |  |  |
+| **week_number** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'timelogic-api'
+
+instance = TimeLogic::Api::CalendarResponse.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,
+  year: null,
+  month: null,
+  month_name: null,
+  day: null,
+  week_number: null
+)
+```
+

data/docs/DiffEndpointRef.md

@@ -0,0 +1,18 @@
+# TimeLogic::Api::DiffEndpointRef
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **unix_ms** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'timelogic-api'
+
+instance = TimeLogic::Api::DiffEndpointRef.new(
+  unix_ms: null
+)
+```
+

data/docs/DiffResponse.md

@@ -0,0 +1,36 @@
+# TimeLogic::Api::DiffResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **seconds** | **Integer** |  |  |
+| **minutes** | **Integer** |  |  |
+| **hours** | **Integer** |  |  |
+| **days** | **Integer** |  |  |
+| **direction** | **String** | `forward` means `to` is after `from`. `backward` means `to` is before `from`. `same` means both sides resolve to the same instant. |  |
+| **human** | **String** |  |  |
+| **formatted** | **String** |  | [optional] |
+| **business_days** | **Integer** |  | [optional] |
+| **from** | [**DiffEndpointRef**](DiffEndpointRef.md) |  |  |
+| **to** | [**DiffEndpointRef**](DiffEndpointRef.md) |  |  |
+
+## Example
+
+```ruby
+require 'timelogic-api'
+
+instance = TimeLogic::Api::DiffResponse.new(
+  seconds: null,
+  minutes: null,
+  hours: null,
+  days: null,
+  direction: null,
+  human: null,
+  formatted: null,
+  business_days: null,
+  from: null,
+  to: null
+)
+```
+

data/docs/DstResponse.md

@@ -0,0 +1,42 @@
+# TimeLogic::Api::DstResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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** |  | [optional] |
+| **dst_active** | **Boolean** |  |  |
+| **next_transition** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'timelogic-api'
+
+instance = TimeLogic::Api::DstResponse.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,
+  dst_active: null,
+  next_transition: null
+)
+```
+

data/docs/ElapsedResponse.md

@@ -0,0 +1,32 @@
+# TimeLogic::Api::ElapsedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **seconds** | **Integer** |  |  |
+| **minutes** | **Integer** |  |  |
+| **hours** | **Integer** |  |  |
+| **days** | **Integer** |  |  |
+| **human** | **String** |  |  |
+| **direction** | **String** | `left` means the target instant is still in the future. `passed` means the target instant is already in the past. |  |
+| **formatted** | **String** |  | [optional] |
+| **business_days** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'timelogic-api'
+
+instance = TimeLogic::Api::ElapsedResponse.new(
+  seconds: null,
+  minutes: null,
+  hours: null,
+  days: null,
+  human: null,
+  direction: null,
+  formatted: null,
+  business_days: null
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,22 @@
+# TimeLogic::Api::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ApiError**](ApiError.md) |  |  |
+| **request_id** | **String** |  |  |
+| **timestamp** | **Time** | Intentionally omitted from public API error responses to avoid exposing request timing; use request_id for support correlation. | [optional] |
+
+## Example
+
+```ruby
+require 'timelogic-api'
+
+instance = TimeLogic::Api::ErrorResponse.new(
+  error: null,
+  request_id: null,
+  timestamp: null
+)
+```
+

data/docs/GetCurrentTime200Response.md

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

data/docs/GetTimezone200Response.md

@@ -0,0 +1,49 @@
+# 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/JwkKey.md

@@ -0,0 +1,28 @@
+# TimeLogic::Api::JwkKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kty** | **String** |  |  |
+| **crv** | **String** |  |  |
+| **alg** | **String** |  |  |
+| **use** | **String** |  |  |
+| **kid** | **String** |  |  |
+| **x** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'timelogic-api'
+
+instance = TimeLogic::Api::JwkKey.new(
+  kty: null,
+  crv: null,
+  alg: null,
+  use: null,
+  kid: ed25519-2026-07-19,
+  x: null
+)
+```
+

data/docs/JwksResponse.md

@@ -0,0 +1,18 @@
+# TimeLogic::Api::JwksResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keys** | [**Array<JwkKey>**](JwkKey.md) |  |  |
+
+## Example
+
+```ruby
+require 'timelogic-api'
+
+instance = TimeLogic::Api::JwksResponse.new(
+  keys: null
+)
+```
+