smplkit 3.0.126 → 3.0.127

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdea2d8c6bc1209eb15b7cee203d4198828d11649e44736b3f03e56b6e8f6cdc
-  data.tar.gz: 0d16250d5093312a3ed248ec166d7c0d3dd2a48bc75c0fc5af485e4ab80fe717
+  metadata.gz: 1d036e83c8a42e16dc643edf8910fea3861ce5073f86743d785cedb5578c8eb9
+  data.tar.gz: 0441f1da63de7e782c9364310cd8f54d8dfda38209c7dfea6b4a49ccf1550e3e
 SHA512:
-  metadata.gz: 574c2b071db99724ec992a120c18de9384cca97b6b9148f1403ac210b1b77d04b954b4d0b76c9f9dd19dc19c8be0e6bd3ccd623bbdf25a99e6b58543310fa140
-  data.tar.gz: 7ca2b72b43196e42dd3d7b5c1869e45d38be55abd9c988d8c90dc640ef9f5c32a73319126b7684a5154a63b33526d5470c1d46ec4aa9ffcbf7d981b26c4a96b3
+  metadata.gz: e3825d3f8bac19ce16c6a89419d71954902be40d5376b1de98311a371b36e35279462439e47548c1b3e66f966afa5b7b079297d44a0ce193f9a0442599c3a606
+  data.tar.gz: 385012586c7f071762d366ac6bc5dbff007ec04d36312861753c5834ffa45f1245bb1d2a9290e5ef59a14bcd4b34602c17d9fecea368102f1200bad4c9ba4078

data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/api/jobs_api.rb

@@ -20,10 +20,9 @@ module SmplkitGeneratedClient::Jobs
       @api_client = api_client
     end
     # Create Job
-    # Create a job for this account.  The caller supplies the job's id as `data.id`. Ids are unique within an account and immutable. The job's kind follows from its `schedule`: omit the schedule for a permanent **manual** job (triggered on demand), give a cron expression for a **recurring** job, or a datetime / `now` for a **one-off** job. A recurring or manual job supplies `environments` to choose where it runs; a recurring job begins scheduling immediately in each enabled environment. A one-off job is created in the environment named by the `X-Smplkit-Environment` header (implied when the credential is scoped to a single environment); a `now` one-off enqueues its single run immediately.
+    # Create a job for this account.  The caller supplies the job's id as `data.id`. Ids are unique within an account and immutable. The job's kind follows from its `schedule`: omit the schedule for a permanent **manual** job (triggered on demand), give a cron expression for a **recurring** job, or a datetime / `now` for a **one-off** job. Supply `environments` to choose where the job runs: a recurring job begins scheduling immediately in each enabled environment, while a one-off job names its target environment(s) by the keys of that map and enqueues one run per environment (a single-environment credential implies the one environment when the map is empty). A `now` one-off enqueues its run(s) immediately.
     # @param job_create_request [JobCreateRequest] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :x_smplkit_environment The environment to operate in. Names the single environment a one-off job is born in (or a manual run executes in). Optional when the credential is scoped to a single environment (which is then implied); required when the credential can reach several environments and the choice is otherwise ambiguous. Ignored for a recurring job, whose environments come from its `environments` map.
     # @return [JobResponse]
     def create_job(job_create_request, opts = {})
       data, _status_code, _headers = create_job_with_http_info(job_create_request, opts)
@@ -31,10 +30,9 @@ module SmplkitGeneratedClient::Jobs
     end
 
     # Create Job
-    # Create a job for this account.  The caller supplies the job's id as `data.id`. Ids are unique within an account and immutable. The job's kind follows from its `schedule`: omit the schedule for a permanent **manual** job (triggered on demand), give a cron expression for a **recurring** job, or a datetime / `now` for a **one-off** job. A recurring or manual job supplies `environments` to choose where it runs; a recurring job begins scheduling immediately in each enabled environment. A one-off job is created in the environment named by the `X-Smplkit-Environment` header (implied when the credential is scoped to a single environment); a `now` one-off enqueues its single run immediately.
+    # Create a job for this account.  The caller supplies the job's id as `data.id`. Ids are unique within an account and immutable. The job's kind follows from its `schedule`: omit the schedule for a permanent **manual** job (triggered on demand), give a cron expression for a **recurring** job, or a datetime / `now` for a **one-off** job. Supply `environments` to choose where the job runs: a recurring job begins scheduling immediately in each enabled environment, while a one-off job names its target environment(s) by the keys of that map and enqueues one run per environment (a single-environment credential implies the one environment when the map is empty). A `now` one-off enqueues its run(s) immediately.
     # @param job_create_request [JobCreateRequest] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :x_smplkit_environment The environment to operate in. Names the single environment a one-off job is born in (or a manual run executes in). Optional when the credential is scoped to a single environment (which is then implied); required when the credential can reach several environments and the choice is otherwise ambiguous. Ignored for a recurring job, whose environments come from its `environments` map.
     # @return [Array<(JobResponse, Integer, Hash)>] JobResponse data, response status code and response headers
     def create_job_with_http_info(job_create_request, opts = {})
       if @api_client.config.debugging
@@ -59,7 +57,6 @@ module SmplkitGeneratedClient::Jobs
       if !content_type.nil?
           header_params['Content-Type'] = content_type
       end
-      header_params[:'X-Smplkit-Environment'] = opts[:'x_smplkit_environment'] if !opts[:'x_smplkit_environment'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -297,10 +294,10 @@ module SmplkitGeneratedClient::Jobs
     end
 
     # Run Job Now
-    # Trigger one immediate run of the job in a specified environment (a `MANUAL` run).  This is the primary execution path for a manual job and is also usable ad hoc for a recurring job (\"run now\"). The job's schedule and enabled state are untouched. The run executes in the environment named by the `X-Smplkit-Environment` header; when the job is enabled in exactly one environment that environment is used, and a single-environment credential implies it. The environment must be one the job is **enabled** in (409 otherwise). The run executes the job's effective configuration for that environment. It is enqueued and executed by the worker; if the account is over its run allotment the run will fail with reason `QUOTA_EXCEEDED` rather than being rejected here.
+    # Trigger one immediate run of the job in a specified environment (a `MANUAL` run).  This is the primary execution path for a manual job and is also usable ad hoc for a recurring job (\"run now\"). The job's schedule and enabled state are untouched. The run executes in the environment named by the request body's `environment`; when the job is enabled in exactly one environment that environment is used, and a single-environment credential implies it. The environment must be one the job is **enabled** in (409 otherwise). The run executes the job's effective configuration for that environment. It is enqueued and executed by the worker; if the account is over its run allotment the run will fail with reason `QUOTA_EXCEEDED` rather than being rejected here.
     # @param job_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :x_smplkit_environment The environment to operate in. Names the single environment a one-off job is born in (or a manual run executes in). Optional when the credential is scoped to a single environment (which is then implied); required when the credential can reach several environments and the choice is otherwise ambiguous. Ignored for a recurring job, whose environments come from its &#x60;environments&#x60; map.
+    # @option opts [RunNowRequest] :run_now_request 
     # @return [RunResponse]
     def run_job_now(job_id, opts = {})
       data, _status_code, _headers = run_job_now_with_http_info(job_id, opts)
@@ -308,10 +305,10 @@ module SmplkitGeneratedClient::Jobs
     end
 
     # Run Job Now
-    # Trigger one immediate run of the job in a specified environment (a &#x60;MANUAL&#x60; run).  This is the primary execution path for a manual job and is also usable ad hoc for a recurring job (\&quot;run now\&quot;). The job&#39;s schedule and enabled state are untouched. The run executes in the environment named by the &#x60;X-Smplkit-Environment&#x60; header; when the job is enabled in exactly one environment that environment is used, and a single-environment credential implies it. The environment must be one the job is **enabled** in (409 otherwise). The run executes the job&#39;s effective configuration for that environment. It is enqueued and executed by the worker; if the account is over its run allotment the run will fail with reason &#x60;QUOTA_EXCEEDED&#x60; rather than being rejected here.
+    # Trigger one immediate run of the job in a specified environment (a &#x60;MANUAL&#x60; run).  This is the primary execution path for a manual job and is also usable ad hoc for a recurring job (\&quot;run now\&quot;). The job&#39;s schedule and enabled state are untouched. The run executes in the environment named by the request body&#39;s &#x60;environment&#x60;; when the job is enabled in exactly one environment that environment is used, and a single-environment credential implies it. The environment must be one the job is **enabled** in (409 otherwise). The run executes the job&#39;s effective configuration for that environment. It is enqueued and executed by the worker; if the account is over its run allotment the run will fail with reason &#x60;QUOTA_EXCEEDED&#x60; rather than being rejected here.
     # @param job_id [String] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :x_smplkit_environment The environment to operate in. Names the single environment a one-off job is born in (or a manual run executes in). Optional when the credential is scoped to a single environment (which is then implied); required when the credential can reach several environments and the choice is otherwise ambiguous. Ignored for a recurring job, whose environments come from its &#x60;environments&#x60; map.
+    # @option opts [RunNowRequest] :run_now_request 
     # @return [Array<(RunResponse, Integer, Hash)>] RunResponse data, response status code and response headers
     def run_job_now_with_http_info(job_id, opts = {})
       if @api_client.config.debugging
@@ -331,13 +328,17 @@ module SmplkitGeneratedClient::Jobs
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json']) unless header_params['Accept']
-      header_params[:'X-Smplkit-Environment'] = opts[:'x_smplkit_environment'] if !opts[:'x_smplkit_environment'].nil?
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/vnd.api+json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body]
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'run_now_request'])
 
       # return_type
       return_type = opts[:debug_return_type] || 'RunResponse'
@@ -363,11 +364,10 @@ module SmplkitGeneratedClient::Jobs
     end
 
     # Update Job
-    # Replace an existing job. Every writable field is overwritten.  The job's kind is re-derived from the new `schedule` (omit it for a manual job). Set enablement per environment via the `environments` map (a recurring or manual job), or by recreating a one-off job in the desired environment. Each environment may carry its own cron `schedule` override (recurring jobs only). Editing a recurring environment's effective schedule recomputes its next fire time; an edit that leaves it unchanged preserves the existing cadence.
+    # Replace an existing job. Every writable field is overwritten.  The job's kind is re-derived from the new `schedule` (omit it for a manual job). Set enablement per environment via the `environments` map (a recurring or manual job), or by recreating a one-off job naming its target environment(s) in that map. Each environment may carry its own cron `schedule` override (recurring jobs only). Editing a recurring environment's effective schedule recomputes its next fire time; an edit that leaves it unchanged preserves the existing cadence.
     # @param job_id [String] 
     # @param job_request [JobRequest] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :x_smplkit_environment The environment to operate in. Names the single environment a one-off job is born in (or a manual run executes in). Optional when the credential is scoped to a single environment (which is then implied); required when the credential can reach several environments and the choice is otherwise ambiguous. Ignored for a recurring job, whose environments come from its &#x60;environments&#x60; map.
     # @return [JobResponse]
     def update_job(job_id, job_request, opts = {})
       data, _status_code, _headers = update_job_with_http_info(job_id, job_request, opts)
@@ -375,11 +375,10 @@ module SmplkitGeneratedClient::Jobs
     end
 
     # Update Job
-    # Replace an existing job. Every writable field is overwritten.  The job&#39;s kind is re-derived from the new &#x60;schedule&#x60; (omit it for a manual job). Set enablement per environment via the &#x60;environments&#x60; map (a recurring or manual job), or by recreating a one-off job in the desired environment. Each environment may carry its own cron &#x60;schedule&#x60; override (recurring jobs only). Editing a recurring environment&#39;s effective schedule recomputes its next fire time; an edit that leaves it unchanged preserves the existing cadence.
+    # Replace an existing job. Every writable field is overwritten.  The job&#39;s kind is re-derived from the new &#x60;schedule&#x60; (omit it for a manual job). Set enablement per environment via the &#x60;environments&#x60; map (a recurring or manual job), or by recreating a one-off job naming its target environment(s) in that map. Each environment may carry its own cron &#x60;schedule&#x60; override (recurring jobs only). Editing a recurring environment&#39;s effective schedule recomputes its next fire time; an edit that leaves it unchanged preserves the existing cadence.
     # @param job_id [String] 
     # @param job_request [JobRequest] 
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :x_smplkit_environment The environment to operate in. Names the single environment a one-off job is born in (or a manual run executes in). Optional when the credential is scoped to a single environment (which is then implied); required when the credential can reach several environments and the choice is otherwise ambiguous. Ignored for a recurring job, whose environments come from its &#x60;environments&#x60; map.
     # @return [Array<(JobResponse, Integer, Hash)>] JobResponse data, response status code and response headers
     def update_job_with_http_info(job_id, job_request, opts = {})
       if @api_client.config.debugging
@@ -408,7 +407,6 @@ module SmplkitGeneratedClient::Jobs
       if !content_type.nil?
           header_params['Content-Type'] = content_type
       end
-      header_params[:'X-Smplkit-Environment'] = opts[:'x_smplkit_environment'] if !opts[:'x_smplkit_environment'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}

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

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::Jobs
-  # A unit of work: an HTTP request, run on a schedule or triggered on demand.  The job is the definition; each time it fires the service records a run capturing the request, response, timing, and outcome. A job runs per environment: set `environments[<env>].enabled` to enable it there, and optionally give that environment its own `schedule` or `configuration`.  A job's `kind` follows from its `schedule`: a **recurring** (cron) job may be enabled in several environments at once and fires once per enabled environment, each on its own next-fire schedule; a **manual** job (no schedule) is permanent and never auto-fires — it runs only when triggered; a **one-off** (`now` or a future datetime) job runs a single time in the environment it was created in and is then spent.
+  # A unit of work: an HTTP request, run on a schedule or triggered on demand.  The job is the definition; each time it fires the service records a run capturing the request, response, timing, and outcome. A job runs per environment: set `environments[<env>].enabled` to enable it there, and optionally give that environment its own `schedule` or `configuration`.  A job's `kind` follows from its `schedule`: a **recurring** (cron) job may be enabled in several environments at once and fires once per enabled environment, each on its own next-fire schedule; a **manual** job (no schedule) is permanent and never auto-fires — it runs only when triggered; a **one-off** (`now` or a future datetime) job runs a single time in each environment it was created in (one run per environment) and is then spent.
   class Job < ApiModelBase
     # Human-readable name for the job.
     attr_accessor :name
@@ -34,7 +34,7 @@ module SmplkitGeneratedClient::Jobs
     # 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 is a flat, sparse overlay: only the leaves that differ from the base definition are present, and everything absent is inherited. Set `enabled` to `true` to run the job in that environment (the base is disabled everywhere; an environment with no entry, or an entry without `enabled: true`, does not run). Overridable leaves are `url`, `method`, `timeout`, `body`, `success_status`, `tls_verify`, `ca_cert`, `schedule` and `timezone` (recurring jobs only), `retry_policy` (the `id` of a retry policy), and an individual header as `headers.<name>` (e.g. `headers.Authorization`). On read, each entry also reports the read-only `next_run_at` for that environment (the next fire time, or `null`). 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 is a flat, sparse overlay: only the leaves that differ from the base definition are present, and everything absent is inherited. Set `enabled` to `true` to run the job in that environment (the base is disabled everywhere; an environment with no entry, or an entry without `enabled: true`, does not run). Overridable leaves are `url`, `method`, `timeout`, `body`, `success_status`, `tls_verify`, `ca_cert`, `schedule` and `timezone` (recurring jobs only), `retry_policy` (the `id` of a retry policy), and an individual header as `headers.<name>` (e.g. `headers.Authorization`). On read, each entry also reports the read-only `next_run_at` for that environment (the next fire time, or `null`). For a recurring or manual job, supply this map to choose where it runs. For a one-off job, name its target environment(s) here as the map keys — one run is enqueued per named environment; when the map is empty a single-environment credential implies the one environment. Every referenced environment must exist for the account.
     attr_accessor :environments
 
     # How overlapping runs are handled. `ALLOW` (the only value today) permits them.

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

@@ -22,7 +22,7 @@ module SmplkitGeneratedClient::Jobs
     # The job's version at the time the run executed.
     attr_accessor :job_version
 
-    # The environment this run executed in. A scheduled run inherits the firing job-environment; a manual run is created in the environment you name with the `X-Smplkit-Environment` header; a rerun copies its source run's environment.
+    # The environment this run executed in. A scheduled run inherits the firing job-environment; a manual run is created in the environment you name in the run request body (implied when your credential is scoped to a single environment); a rerun copies its source run's environment.
     attr_accessor :environment
 
     # Why the run exists: `SCHEDULE`, `MANUAL` (Run now), `RERUN`, or `RETRY` (an automatic retry of a failed run).

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

@@ -0,0 +1,150 @@
+=begin
+#smplkit Jobs API
+
+#Scheduled HTTP job execution API for smplkit.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::Jobs
+  # Request body for the run-now action (`POST /jobs/{id}/actions/run`).  A plain object (not a JSON:API envelope), matching the platform convention for action endpoints. The body itself is optional — omit it entirely when the target environment is unambiguous.
+  class RunNowRequest < ApiModelBase
+    # The environment to run the job in. Must be one the job is **enabled** in (otherwise the request is rejected). Optional when the target is unambiguous: when the job is enabled in exactly one environment, or your credential is scoped to a single environment, that environment is used.
+    attr_accessor :environment
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'environment' => :'environment'
+      }
+    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
+      {
+        :'environment' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'environment'
+      ])
+    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 `SmplkitGeneratedClient::Jobs::RunNowRequest` 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 `SmplkitGeneratedClient::Jobs::RunNowRequest`. 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?(:'environment')
+        self.environment = attributes[:'environment']
+      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
+      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'
+      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 &&
+          environment == o.environment
+    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
+      [environment].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/smplkit/_generated/jobs/lib/smplkit_jobs_client.rb

@@ -41,6 +41,7 @@ require 'smplkit_jobs_client/models/run'
 require 'smplkit_jobs_client/models/run_list_links'
 require 'smplkit_jobs_client/models/run_list_meta'
 require 'smplkit_jobs_client/models/run_list_response'
+require 'smplkit_jobs_client/models/run_now_request'
 require 'smplkit_jobs_client/models/run_resource'
 require 'smplkit_jobs_client/models/run_response'
 require 'smplkit_jobs_client/models/run_retry'

data/lib/smplkit/_generated/jobs/spec/api/jobs_api_spec.rb

@@ -34,10 +34,9 @@ describe 'JobsApi' do
 
   # unit tests for create_job
   # Create Job
-  # Create a job for this account.  The caller supplies the job's id as `data.id`. Ids are unique within an account and immutable. The job's kind follows from its `schedule`: omit the schedule for a permanent **manual** job (triggered on demand), give a cron expression for a **recurring** job, or a datetime / `now` for a **one-off** job. A recurring or manual job supplies `environments` to choose where it runs; a recurring job begins scheduling immediately in each enabled environment. A one-off job is created in the environment named by the `X-Smplkit-Environment` header (implied when the credential is scoped to a single environment); a `now` one-off enqueues its single run immediately.
+  # Create a job for this account.  The caller supplies the job's id as `data.id`. Ids are unique within an account and immutable. The job's kind follows from its `schedule`: omit the schedule for a permanent **manual** job (triggered on demand), give a cron expression for a **recurring** job, or a datetime / `now` for a **one-off** job. Supply `environments` to choose where the job runs: a recurring job begins scheduling immediately in each enabled environment, while a one-off job names its target environment(s) by the keys of that map and enqueues one run per environment (a single-environment credential implies the one environment when the map is empty). A `now` one-off enqueues its run(s) immediately.
   # @param job_create_request 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :x_smplkit_environment The environment to operate in. Names the single environment a one-off job is born in (or a manual run executes in). Optional when the credential is scoped to a single environment (which is then implied); required when the credential can reach several environments and the choice is otherwise ambiguous. Ignored for a recurring job, whose environments come from its `environments` map.
   # @return [JobResponse]
   describe 'create_job test' do
     it 'should work' do
@@ -89,10 +88,10 @@ describe 'JobsApi' do
 
   # unit tests for run_job_now
   # Run Job Now
-  # Trigger one immediate run of the job in a specified environment (a `MANUAL` run).  This is the primary execution path for a manual job and is also usable ad hoc for a recurring job (\"run now\"). The job's schedule and enabled state are untouched. The run executes in the environment named by the `X-Smplkit-Environment` header; when the job is enabled in exactly one environment that environment is used, and a single-environment credential implies it. The environment must be one the job is **enabled** in (409 otherwise). The run executes the job's effective configuration for that environment. It is enqueued and executed by the worker; if the account is over its run allotment the run will fail with reason `QUOTA_EXCEEDED` rather than being rejected here.
+  # Trigger one immediate run of the job in a specified environment (a `MANUAL` run).  This is the primary execution path for a manual job and is also usable ad hoc for a recurring job (\"run now\"). The job's schedule and enabled state are untouched. The run executes in the environment named by the request body's `environment`; when the job is enabled in exactly one environment that environment is used, and a single-environment credential implies it. The environment must be one the job is **enabled** in (409 otherwise). The run executes the job's effective configuration for that environment. It is enqueued and executed by the worker; if the account is over its run allotment the run will fail with reason `QUOTA_EXCEEDED` rather than being rejected here.
   # @param job_id 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :x_smplkit_environment The environment to operate in. Names the single environment a one-off job is born in (or a manual run executes in). Optional when the credential is scoped to a single environment (which is then implied); required when the credential can reach several environments and the choice is otherwise ambiguous. Ignored for a recurring job, whose environments come from its `environments` map.
+  # @option opts [RunNowRequest] :run_now_request 
   # @return [RunResponse]
   describe 'run_job_now test' do
     it 'should work' do
@@ -102,11 +101,10 @@ describe 'JobsApi' do
 
   # unit tests for update_job
   # Update Job
-  # Replace an existing job. Every writable field is overwritten.  The job's kind is re-derived from the new `schedule` (omit it for a manual job). Set enablement per environment via the `environments` map (a recurring or manual job), or by recreating a one-off job in the desired environment. Each environment may carry its own cron `schedule` override (recurring jobs only). Editing a recurring environment's effective schedule recomputes its next fire time; an edit that leaves it unchanged preserves the existing cadence.
+  # Replace an existing job. Every writable field is overwritten.  The job's kind is re-derived from the new `schedule` (omit it for a manual job). Set enablement per environment via the `environments` map (a recurring or manual job), or by recreating a one-off job naming its target environment(s) in that map. Each environment may carry its own cron `schedule` override (recurring jobs only). Editing a recurring environment's effective schedule recomputes its next fire time; an edit that leaves it unchanged preserves the existing cadence.
   # @param job_id 
   # @param job_request 
   # @param [Hash] opts the optional parameters
-  # @option opts [String] :x_smplkit_environment The environment to operate in. Names the single environment a one-off job is born in (or a manual run executes in). Optional when the credential is scoped to a single environment (which is then implied); required when the credential can reach several environments and the choice is otherwise ambiguous. Ignored for a recurring job, whose environments come from its `environments` map.
   # @return [JobResponse]
   describe 'update_job test' do
     it 'should work' do

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

@@ -0,0 +1,36 @@
+=begin
+#smplkit Jobs API
+
+#Scheduled HTTP job execution API for smplkit.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for SmplkitGeneratedClient::Jobs::RunNowRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe SmplkitGeneratedClient::Jobs::RunNowRequest do
+  #let(:instance) { SmplkitGeneratedClient::Jobs::RunNowRequest.new }
+
+  describe 'test an instance of RunNowRequest' do
+    it 'should create an instance of RunNowRequest' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Jobs::RunNowRequest)
+    end
+  end
+
+  describe 'test attribute "environment"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/lib/smplkit/jobs/client.rb

@@ -395,7 +395,7 @@ module Smplkit
         _new_job(
           id, name: name, schedule: schedule, timezone: timezone, retry_policy: retry_policy,
               configuration: configuration, description: description, environments: environments,
-              concurrency_policy: concurrency_policy, environment: nil
+              concurrency_policy: concurrency_policy
         )
       end
 
@@ -429,7 +429,7 @@ module Smplkit
         _new_job(
           id, name: name, schedule: nil, retry_policy: retry_policy,
               configuration: configuration, description: description, environments: environments,
-              concurrency_policy: concurrency_policy, environment: nil
+              concurrency_policy: concurrency_policy
         )
       end
 
@@ -458,8 +458,9 @@ module Smplkit
                    concurrency_policy: "ALLOW", retry_policy: nil, environment: nil)
         _new_job(
           id, name: name, schedule: schedule.iso8601, retry_policy: retry_policy,
-              configuration: configuration, description: description, environments: nil,
-              concurrency_policy: concurrency_policy, environment: environment
+              configuration: configuration, description: description,
+              environments: birth_env_map(environment.nil? ? @environment : environment),
+              concurrency_policy: concurrency_policy
         )
       end
 
@@ -525,7 +526,12 @@ module Smplkit
       #   set to +MANUAL+.
       def run(id, environment: nil)
         env = environment.nil? ? @environment : environment
-        resp = Jobs.call_api { @api.run_job_now(id, x_smplkit_environment: env) }
+        # The target environment now travels in the run-now request body (the
+        # X-Smplkit-Environment header was dropped). When no environment is
+        # resolved, send no body at all so the service implies it.
+        opts = {}
+        opts[:run_now_request] = SmplkitGeneratedClient::Jobs::RunNowRequest.new(environment: env) unless env.nil?
+        resp = Jobs.call_api { @api.run_job_now(id, opts) }
         Run.from_resource(resp.data, runs: @runs)
       end
 
@@ -540,18 +546,19 @@ module Smplkit
       # @api private — POST a new job. Called by {Smplkit::Jobs::Job#save} on
       #   unsaved instances. The jobs service requires a caller-supplied
       #   +data.id+ on create and 409s on conflict. A one-off job's birth
-      #   environment travels as the +X-Smplkit-Environment+ header.
+      #   environment travels as an enabled entry in the body's +environments+
+      #   map (see {#_new_job}); there is no request header.
       def _create_job(job)
         raise ArgumentError, "Job.id is required on create (caller-supplied key)" if job.id.nil? || job.id.empty?
 
-        resp = Jobs.call_api { @api.create_job(build_create_body(job), x_smplkit_environment: job.birth_environment) }
+        resp = Jobs.call_api { @api.create_job(build_create_body(job)) }
         Job.from_resource(resp.data, client: self)
       end
 
       # @api private — Full-replace PUT for an existing job. Called by
-      #   {Smplkit::Jobs::Job#save} on instances with +created_at+. The client's
-      #   configured environment (if any) travels as the +X-Smplkit-Environment+
-      #   header.
+      #   {Smplkit::Jobs::Job#save} on instances with +created_at+. The target
+      #   environment travels in the body (the +environments+ map), so the update
+      #   carries no environment header.
       #
       # Header values come back in plaintext on the GET path, so a fetched job
       # round-trips through this full-replace PUT with its header values intact
@@ -559,7 +566,7 @@ module Smplkit
       def _update_job(job)
         raise ArgumentError, "cannot update a Job with no id" if job.id.nil?
 
-        resp = Jobs.call_api { @api.update_job(job.id, build_body(job), x_smplkit_environment: @environment) }
+        resp = Jobs.call_api { @api.update_job(job.id, build_body(job)) }
         Job.from_resource(resp.data, client: self)
       end
 
@@ -569,7 +576,7 @@ module Smplkit
       # public constructors ({#new_recurring_job}, {#new_manual_job}, {#schedule})
       # funnel through here.
       def _new_job(id, name:, schedule:, configuration:, description:,
-                   environments:, concurrency_policy:, environment:,
+                   environments:, concurrency_policy:,
                    timezone: nil, retry_policy: nil)
         Job.new(
           self,
@@ -581,11 +588,21 @@ module Smplkit
           configuration: configuration,
           description: description,
           environments: Jobs.normalize_environments(environments),
-          concurrency_policy: concurrency_policy,
-          birth_environment: environment.nil? ? @environment : environment
+          concurrency_policy: concurrency_policy
         )
       end
 
+      # A one-off job's birth environment as an enabled +environments+ entry.
+      # The target environment of a one-off job is now conveyed by a key of the
+      # body's +environments+ map (there is no request header). Returns +nil+
+      # when the environment is unknown, leaving the map empty so a
+      # single-environment credential implies it server-side.
+      def birth_env_map(environment)
+        return nil if environment.nil? || environment.empty?
+
+        { environment => JobEnvironment.new(enabled: true) }
+      end
+
       # Convert the wrapper +environments+ map to the flat per-environment overlay
       # the generated +Job+ model carries (ADR-056). Each value is the
       # environment's sparse leaf-path overlay: +enabled+ plus only the leaves it

data/lib/smplkit/jobs/models.rb

@@ -562,16 +562,10 @@ module Smplkit
       #   server-side write.
       attr_accessor :version
 
-      # @api private — For a one-off job, the environment it is born in, sent as
-      #   the +X-Smplkit-Environment+ header by {JobsClient#_create_job}. Ignored
-      #   for recurring and manual jobs, whose environments come from
-      #   {#environments}.
-      attr_accessor :birth_environment
-
       def initialize(client = nil, id:, name:, configuration:, schedule: nil,
                      timezone: nil, retry_policy: nil, description: nil, environments: nil,
                      kind: nil, type: "http", concurrency_policy: "ALLOW",
-                     birth_environment: nil, created_at: nil,
+                     created_at: nil,
                      updated_at: nil, deleted_at: nil, version: nil)
         @client = client
         @id = id
@@ -585,7 +579,6 @@ module Smplkit
         self.retry_policy = retry_policy
         @configuration = configuration
         @concurrency_policy = concurrency_policy
-        @birth_environment = birth_environment
         @created_at = created_at
         @updated_at = updated_at
         @deleted_at = deleted_at

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 3.0.126
+  version: 3.0.127
 platform: ruby
 authors:
 - Smpl Solutions LLC
@@ -783,6 +783,7 @@ files:
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/run_list_links.rb
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/run_list_meta.rb
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/run_list_response.rb
+- lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/run_now_request.rb
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/run_resource.rb
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/run_response.rb
 - lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/run_retry.rb
@@ -816,6 +817,7 @@ files:
 - lib/smplkit/_generated/jobs/spec/models/run_list_links_spec.rb
 - lib/smplkit/_generated/jobs/spec/models/run_list_meta_spec.rb
 - lib/smplkit/_generated/jobs/spec/models/run_list_response_spec.rb
+- lib/smplkit/_generated/jobs/spec/models/run_now_request_spec.rb
 - lib/smplkit/_generated/jobs/spec/models/run_resource_spec.rb
 - lib/smplkit/_generated/jobs/spec/models/run_response_spec.rb
 - lib/smplkit/_generated/jobs/spec/models/run_retry_spec.rb