smplkit 3.0.114 → 3.0.116

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac8fe2c97dbe9e809353ffa9240572f0b8121322dce79d599308dba14bf89654
-  data.tar.gz: '04689fee543ee875c6d8b0ba68ed3cbd67242a490bee6ed3dafd5b33e030348e'
+  metadata.gz: bc58dc086c7fddd47a59bf3db2136dafb156549fe8d062957209ef0b0057b341
+  data.tar.gz: 422145f651bc3490f5210d436aee72682b40dc57407d3edd2c3ad65a80ff71db
 SHA512:
-  metadata.gz: 1f26e6bec44ef6259a7d384ce5cd80c99eba77116a73bd22c3be814fcf683712a6a8b2fd1774e3a0e76cfe58bf28fc0184edcd91266ce3b453db60dd1a6e7fea
-  data.tar.gz: bee0e18d7f5d8f4b9bbe64085da2782888ecd82fff072c92d4f81c4379c27f21dfc82643d26261d7a7c0af809b58d112239ae12e840c11b989331dd22317fd29
+  metadata.gz: 8bbddde3e3c7539bde483e6f0cf3faf9e9df1915560e8e42c107d53c0c79b035c971c4030daa301d9ed6b27ee78b834d445746113c5b227ffdd8389ddf4c1f49
+  data.tar.gz: ea6492fa6de7972f79ad7b56c84bcc53a6e7f157ce19c29d1e80087652eac775d3c028c171a50e4ce6afde8486cdf0abf86e958642b730a4286099d19ab7f674

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job.rb

@@ -25,13 +25,16 @@ module SmplkitGeneratedClient::Jobs
     # Job type. Only `http` is supported today.
     attr_accessor :type
 
-    # The base schedule every environment inherits unless it overrides it, and the field that determines the job's `kind`. Omit it (or send `null`) to create a permanent **manual** job that never auto-fires and runs only when triggered. Provide a 5-field cron expression evaluated in **UTC** for a **recurring** job, an ISO-8601 datetime for a **one-off** run at that instant, or the literal `now` for a one-off run as soon as possible. A datetime or `now` job disables itself after it fires.
+    # The base schedule every environment inherits unless it overrides it, and the field that determines the job's `kind`. Omit it (or send `null`) to create a permanent **manual** job that never auto-fires and runs only when triggered. Provide a 5-field cron expression evaluated in the job's `timezone` (UTC by default) for a **recurring** job, an ISO-8601 datetime for a **one-off** run at that instant, or the literal `now` for a one-off run as soon as possible. A datetime or `now` job disables itself after it fires.
     attr_accessor :schedule
 
+    # IANA timezone the cron `schedule` is evaluated in (e.g. `America/New_York`); null or omitted means UTC. The base every environment inherits unless it sets its own `timezone`. The cron fires on this zone's wall clock (DST-aware) while `next_run_at` is still reported as a UTC instant. Only valid on a recurring (cron) job — it cannot be set on a manual or one-off job.
+    attr_accessor :timezone
+
     # The HTTP request to perform, including method, url, headers, body, and timeout.
     attr_accessor :configuration
 
-    # Per-environment overrides keyed by environment key (e.g. `production`, `staging`). Each entry sets `enabled` (whether the job is enabled — scheduled, for a recurring job, or triggerable, for a manual job — in that environment), an optional `schedule` override (a cron expression for recurring jobs; omit to inherit the base `schedule`), and an optional `configuration` override (omit to inherit the base `configuration`); it also reports the read-only `next_run_at` for that environment. A job with no entry for an environment is disabled there. For a recurring or manual job, supply this map to choose where it runs. For a one-off job, the environment it is created in is recorded here automatically — name it with the `X-Smplkit-Environment` header. Every referenced environment must exist for the account.
+    # Per-environment overrides keyed by environment key (e.g. `production`, `staging`). Each entry sets `enabled` (whether the job is enabled — scheduled, for a recurring job, or triggerable, for a manual job — in that environment), an optional `schedule` override (a cron expression for recurring jobs; omit to inherit the base `schedule`), an optional `timezone` override (an IANA zone for recurring jobs; omit to inherit the base `timezone`, else UTC), and an optional `configuration` override (omit to inherit the base `configuration`); it also reports the read-only `next_run_at` for that environment. A job with no entry for an environment is disabled there. For a recurring or manual job, supply this map to choose where it runs. For a one-off job, the environment it is created in is recorded here automatically — name it with the `X-Smplkit-Environment` header. Every referenced environment must exist for the account.
     attr_accessor :environments
 
     # How overlapping runs are handled. `ALLOW` (the only value today) permits them.
@@ -81,6 +84,7 @@ module SmplkitGeneratedClient::Jobs
         :'description' => :'description',
         :'type' => :'type',
         :'schedule' => :'schedule',
+        :'timezone' => :'timezone',
         :'configuration' => :'configuration',
         :'environments' => :'environments',
         :'concurrency_policy' => :'concurrency_policy',
@@ -109,6 +113,7 @@ module SmplkitGeneratedClient::Jobs
         :'description' => :'String',
         :'type' => :'String',
         :'schedule' => :'String',
+        :'timezone' => :'String',
         :'configuration' => :'JobHttpConfiguration',
         :'environments' => :'Hash<String, JobEnvironment>',
         :'concurrency_policy' => :'String',
@@ -125,6 +130,7 @@ module SmplkitGeneratedClient::Jobs
       Set.new([
         :'description',
         :'schedule',
+        :'timezone',
         :'kind',
         :'created_at',
         :'updated_at',
@@ -169,6 +175,10 @@ module SmplkitGeneratedClient::Jobs
         self.schedule = attributes[:'schedule']
       end
 
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
       if attributes.key?(:'configuration')
         self.configuration = attributes[:'configuration']
       else
@@ -331,6 +341,7 @@ module SmplkitGeneratedClient::Jobs
           description == o.description &&
           type == o.type &&
           schedule == o.schedule &&
+          timezone == o.timezone &&
           configuration == o.configuration &&
           environments == o.environments &&
           concurrency_policy == o.concurrency_policy &&
@@ -350,7 +361,7 @@ module SmplkitGeneratedClient::Jobs
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, type, schedule, configuration, environments, concurrency_policy, kind, created_at, updated_at, deleted_at, version].hash
+      [name, description, type, schedule, timezone, configuration, environments, concurrency_policy, kind, created_at, updated_at, deleted_at, version].hash
     end
 
     # Builds the object from hash

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job_environment.rb

@@ -19,9 +19,12 @@ module SmplkitGeneratedClient::Jobs
     # Whether the job schedules runs in this environment. A job runs in an environment only via this field; it is disabled in every environment by default.
     attr_accessor :enabled
 
-    # Per-environment schedule override. Omit to inherit the job's base `schedule`. When present, it must be a 5-field cron expression evaluated in **UTC** (e.g. `0 3 * * *`), and is only allowed on a recurring (cron) job — it varies the cadence within that environment. It cannot appear on a manual or one-off job, and cannot change a job's kind.
+    # Per-environment schedule override. Omit to inherit the job's base `schedule`. When present, it must be a 5-field cron expression (e.g. `0 3 * * *`), evaluated in this environment's effective `timezone` (the per-environment override, else the base, else UTC), and is only allowed on a recurring (cron) job — it varies the cadence within that environment. It cannot appear on a manual or one-off job, and cannot change a job's kind.
     attr_accessor :schedule
 
+    # Per-environment timezone override for evaluating this environment's cron `schedule`. Omit to inherit the base `timezone` (else UTC). When present, it must be a valid IANA timezone key (e.g. `America/New_York`). Only valid on a recurring (cron) job; it may be set on an environment that inherits the base schedule (it need not also override `schedule`).
+    attr_accessor :timezone
+
     # Per-environment HTTP request override. Omit to inherit the job's base `configuration`. When present, it fully replaces the base configuration for runs in this environment.
     attr_accessor :configuration
 
@@ -33,6 +36,7 @@ module SmplkitGeneratedClient::Jobs
       {
         :'enabled' => :'enabled',
         :'schedule' => :'schedule',
+        :'timezone' => :'timezone',
         :'configuration' => :'configuration',
         :'next_run_at' => :'next_run_at'
       }
@@ -53,6 +57,7 @@ module SmplkitGeneratedClient::Jobs
       {
         :'enabled' => :'Boolean',
         :'schedule' => :'String',
+        :'timezone' => :'String',
         :'configuration' => :'JobHttpConfiguration',
         :'next_run_at' => :'Time'
       }
@@ -62,6 +67,7 @@ module SmplkitGeneratedClient::Jobs
     def self.openapi_nullable
       Set.new([
         :'schedule',
+        :'timezone',
         :'configuration',
         :'next_run_at'
       ])
@@ -93,6 +99,10 @@ module SmplkitGeneratedClient::Jobs
         self.schedule = attributes[:'schedule']
       end
 
+      if attributes.key?(:'timezone')
+        self.timezone = attributes[:'timezone']
+      end
+
       if attributes.key?(:'configuration')
         self.configuration = attributes[:'configuration']
       end
@@ -124,6 +134,7 @@ module SmplkitGeneratedClient::Jobs
       self.class == o.class &&
           enabled == o.enabled &&
           schedule == o.schedule &&
+          timezone == o.timezone &&
           configuration == o.configuration &&
           next_run_at == o.next_run_at
     end
@@ -137,7 +148,7 @@ module SmplkitGeneratedClient::Jobs
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [enabled, schedule, configuration, next_run_at].hash
+      [enabled, schedule, timezone, configuration, next_run_at].hash
     end
 
     # Builds the object from hash

data/lib/smplkit/_generated/jobs/spec/models/job_environment_spec.rb

@@ -39,6 +39,12 @@ describe SmplkitGeneratedClient::Jobs::JobEnvironment do
     end
   end
 
+  describe 'test attribute "timezone"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "configuration"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/lib/smplkit/_generated/jobs/spec/models/job_spec.rb

@@ -55,6 +55,12 @@ describe SmplkitGeneratedClient::Jobs::Job do
     end
   end
 
+  describe 'test attribute "timezone"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "configuration"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/lib/smplkit/jobs/client.rb

@@ -394,13 +394,15 @@ module Smplkit
       # Convert the wrapper +environments+ map to the generated model hash.
       #
       # Each entry's +enabled+ is always written; a per-environment +schedule+
-      # (cron) override and +configuration+ override are each sent only when
-      # present (omit to inherit the job's base +schedule+ / +configuration+).
-      # The read-only per-environment +next_run_at+ is never written.
+      # (cron) override, +timezone+ override, and +configuration+ override are
+      # each sent only when present (omit to inherit the job's base +schedule+ /
+      # +timezone+ / +configuration+). The read-only per-environment
+      # +next_run_at+ is never written.
       def environments_to_wire(environments)
         (environments || {}).each_with_object({}) do |(env_key, env), out|
           attrs = { enabled: env.enabled }
           attrs[:schedule] = env.schedule unless env.schedule.nil?
+          attrs[:timezone] = env.timezone unless env.timezone.nil?
           attrs[:configuration] = HttpConfig.to_wire(env.configuration) unless env.configuration.nil?
           out[env_key.to_s] = SmplkitGeneratedClient::Jobs::JobEnvironment.new(attrs)
         end
@@ -418,6 +420,11 @@ module Smplkit
           configuration: HttpConfig.to_wire(job.configuration),
           concurrency_policy: job.concurrency_policy
         }
+        # +timezone+ is only valid on a recurring (cron) job; an unset +nil+ is
+        # omitted, leaving the server default of UTC. (Unlike +schedule+, whose
+        # explicit +null+ creates a manual job, omitting +timezone+ simply
+        # inherits UTC — so it is sent only when present.)
+        attrs[:timezone] = job.timezone unless job.timezone.nil?
         environments = job.environments
         attrs[:environments] = environments_to_wire(environments) unless environments.nil? || environments.empty?
         SmplkitGeneratedClient::Jobs::Job.new(attrs)

data/lib/smplkit/jobs/models.rb

@@ -79,7 +79,8 @@ module Smplkit
     # (+{ enabled: true, schedule: "0 3 * * *", configuration: HttpConfig.new(...) }+)
     # so callers can use the lightweight hash form without importing the model. A
     # dict-form +configuration+ override is coerced to an {HttpConfig} so it
-    # serializes on save; an optional +schedule+ cron override passes through.
+    # serializes on save; optional +schedule+ cron and +timezone+ overrides pass
+    # through.
     #
     # @api private
     def self.normalize_environments(environments)
@@ -94,6 +95,7 @@ module Smplkit
                               JobEnvironment.new(
                                 enabled: value[:enabled] || value["enabled"] || false,
                                 schedule: value[:schedule] || value["schedule"],
+                                timezone: value[:timezone] || value["timezone"],
                                 configuration: cfg
                               )
                             end
@@ -291,6 +293,13 @@ module Smplkit
     #     inherits the job's base {Job#schedule}. When present, it must be a
     #     5-field UTC cron expression and is only meaningful on a recurring job —
     #     it cannot turn a one-off job recurring or vice-versa.
+    # @!attribute [rw] timezone
+    #   @return [String, nil] Optional per-environment IANA timezone override for
+    #     evaluating this environment's cron {#schedule} (recurring jobs only).
+    #     +nil+ (the default) inherits the base {Job#timezone}, else UTC. When
+    #     present, it must be a valid IANA zone key (e.g. +"America/New_York"+);
+    #     it may be set on an environment that inherits the base schedule (it
+    #     need not also override {#schedule}). Sent on writes only when present.
     # @!attribute [rw] configuration
     #   @return [HttpConfig, nil] Optional per-environment request configuration
     #     that fully replaces the job's base {Job#configuration} for this
@@ -301,8 +310,8 @@ module Smplkit
     #   @return [String, nil] Read-only. The next scheduled fire time in this
     #     environment. +nil+ when the environment is not enabled, or once a
     #     one-off run has fired. Never written back on save.
-    JobEnvironment = Struct.new(:enabled, :schedule, :configuration, :next_run_at, keyword_init: true) do
-      def initialize(enabled: false, schedule: nil, configuration: nil, next_run_at: nil)
+    JobEnvironment = Struct.new(:enabled, :schedule, :timezone, :configuration, :next_run_at, keyword_init: true) do
+      def initialize(enabled: false, schedule: nil, timezone: nil, configuration: nil, next_run_at: nil)
         super
       end
 
@@ -318,6 +327,7 @@ module Smplkit
         new(
           enabled: src.enabled.nil? ? false : src.enabled,
           schedule: src.schedule,
+          timezone: src.timezone,
           configuration: cfg.nil? ? nil : HttpConfig.from_wire(cfg),
           next_run_at: src.next_run_at
         )
@@ -386,6 +396,16 @@ module Smplkit
       #   {#set_schedule}.
       attr_accessor :schedule
 
+      # @return [String, nil] The base IANA timezone the cron {#schedule} is
+      #   evaluated in (e.g. +"America/New_York"+); +nil+ (the default) means
+      #   UTC. The base every environment inherits unless it sets its own
+      #   {JobEnvironment#timezone}. The cron fires on this zone's wall clock
+      #   (DST-aware) while +next_run_at+ is still reported as a UTC instant.
+      #   Only valid on a recurring (cron) job — leave +nil+ for a manual or
+      #   one-off job. Set it with {#set_timezone}; sent on writes only when
+      #   present.
+      attr_accessor :timezone
+
       # @return [HttpConfig] The base HTTP request to perform when the job fires.
       #   Per-environment overrides live in {#environments}.
       attr_accessor :configuration
@@ -416,7 +436,7 @@ module Smplkit
       attr_accessor :birth_environment
 
       def initialize(client = nil, id:, name:, configuration:, schedule: nil,
-                     description: nil, environments: nil,
+                     timezone: nil, description: nil, environments: nil,
                      kind: nil, type: "http", concurrency_policy: "ALLOW",
                      birth_environment: nil, created_at: nil,
                      updated_at: nil, deleted_at: nil, version: nil)
@@ -428,6 +448,7 @@ module Smplkit
         @kind = kind
         @type = type
         @schedule = schedule
+        @timezone = timezone
         @configuration = configuration
         @concurrency_policy = concurrency_policy
         @birth_environment = birth_environment
@@ -580,6 +601,29 @@ module Smplkit
         end
       end
 
+      # Set the IANA timezone the cron schedule is evaluated in — base
+      # (+environment+ omitted) or per-environment.
+      #
+      # With +environment+ omitted (the default), sets the base {#timezone}
+      # every environment inherits unless it overrides it. With an +environment+
+      # given, sets that environment's per-environment +timezone+ override on
+      # {#environments}, creating the override entry if it doesn't exist yet
+      # (preserving any already-set +enabled+ / +schedule+ / +configuration+ on
+      # it). A timezone is only valid on a recurring (cron) job; +nil+ means UTC
+      # (base) or "inherit the base" (per-environment). Call {#save} to persist.
+      #
+      # @param timezone [String, nil] A valid IANA timezone key (e.g.
+      #   +"America/New_York"+), or +nil+ for UTC / inherit.
+      # @param environment [String, nil] An environment key for a per-environment
+      #   override, or +nil+ to set the base timezone.
+      def set_timezone(timezone, environment: nil)
+        if environment.nil?
+          @timezone = timezone
+        else
+          _environment_override(environment).timezone = timezone
+        end
+      end
+
       # Trigger one immediate, manual run of this job (a +MANUAL+ run).
       #
       # @param environment [String, nil] Environment the run executes in.
@@ -633,6 +677,7 @@ module Smplkit
         @kind = other.kind
         @type = other.type
         @schedule = other.schedule
+        @timezone = other.timezone
         @configuration = other.configuration
         @concurrency_policy = other.concurrency_policy
         @created_at = other.created_at
@@ -663,6 +708,7 @@ module Smplkit
           kind: a.kind,
           type: a.type || "http",
           schedule: a.schedule,
+          timezone: a.timezone,
           configuration: HttpConfig.from_wire(a.configuration),
           concurrency_policy: a.concurrency_policy || "ALLOW",
           created_at: a.created_at,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 3.0.114
+  version: 3.0.116
 platform: ruby
 authors:
 - Smpl Solutions LLC