plainrouter-sdk 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d07536a899759d655186ed696485ba78ba44a49ba28c032895c2fb45922fd507
-  data.tar.gz: fac0245734efe9e3c0a3d9903e33cb69c50ba700889dd39e058edab1798ba306
+  metadata.gz: 3af4afbf5b335f3602353873f9cffac36d4d183a2528ca3f9966fe22ed971642
+  data.tar.gz: c9dba9aef741159204bf5eefa3b845ef24a7c7801631b5b8523824abf6c1e9da
 SHA512:
-  metadata.gz: 2001157c525c4691c497838e78b3a673d9b43075f374c7351ba43103b7ead6834d9bd85daa6ea74ed9db40703be7c49030fcdc43dd6665e1eadc41d9d64a3ebe
-  data.tar.gz: 427d042e63b3221cf89b9089e921434fd44bd99ae48025469f35214c8b059727024634b360c1d47174f9b3c1f484ae0ac55d45ac3e5b503b94bf02da94803595
+  metadata.gz: 16cefffc78d545efd2809b141e9f2fec84e7bc3e3a5bd326203a606f911bb94974b901a29ed903938a35e840ef11404faf78880ce08deb8f86326448b92317e2
+  data.tar.gz: 2ff1a28fbe3c4f75cbf45fd9ec50b1be157a83f147f7d7f009863628deca79ea5c7dbb95d940a1fe5b53f66d9fbfa09eaf1a29120a9b8a680d51027107c745fb

data/README.md

@@ -1,6 +1,6 @@
-# PlainRouter Ruby SDK
+# Plainrouter Ruby SDK
 
-The official Ruby SDK for the PlainRouter Signals Conversion API. It is generated from the repository's signed OpenAPI contract and is currently in `0.x` development.
+The official Ruby SDK for the Plainrouter Signals Conversion API. It is generated from the repository's signed OpenAPI contract and is currently in `0.x` development.
 
 ## Install
 

data/lib/plainrouter/client.rb

@@ -1,10 +1,81 @@
 # frozen_string_literal: true
 
 require "uri"
+require "date"
 
 module PlainRouter
-  # Compact entry point for the PlainRouter API.
+  # Compact entry point for the Plainrouter API.
   class Client
+    module EventsValidation
+      # Keep this literal identical to app/Domains/Signals/Data/ConsentDecision.php::CAPTURED_AT_PATTERN.
+      CAPTURED_AT_PATTERN = '/\A(?<datetime>\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2})(?:\.(?<fraction>\d{1,6}))?(?<offset>Z|[+-](?:[01]\d|2[0-3]):[0-5]\d)\z/'
+      CAPTURED_AT_REGEX = Regexp.new(CAPTURED_AT_PATTERN[1...-1])
+
+      def create_event(create_event_request, opts = {})
+        data, _status_code, _headers = create_event_with_http_info(create_event_request, opts)
+        data
+      end
+
+      def create_event_with_http_info(create_event_request, opts = {})
+        validate_create_event_body(create_event_request)
+
+        data, status_code, headers = super(
+          create_event_request,
+          opts.merge(debug_return_type: "Object")
+        )
+
+        typed_data = case status_code
+                     when 200
+                       OpenAPI::CreateEvent200Response.build_from_hash(data)
+                     when 202
+                       OpenAPI::CreateEvent202Response.build_from_hash(data)
+                     else
+                       data
+                     end
+
+        [typed_data, status_code, headers]
+      end
+
+      private
+
+      def validate_create_event_body(body)
+        visitor_id = event_value(body, :visitor_id)
+        user_data = event_value(body, :user_data)
+        return if visitor_id.nil? && user_data.nil?
+
+        consent = event_value(body, :consent)
+        captured_at = event_value(consent, :captured_at)
+
+        if captured_at.nil?
+          raise ArgumentError,
+                "consent.captured_at is required when visitor_id or user_data is present (missing)."
+        end
+
+        return if valid_captured_at?(captured_at)
+
+        raise ArgumentError,
+              "consent.captured_at has invalid format; expected the strict ISO-8601 capture time grammar (invalid format)."
+      end
+
+      def event_value(value, key)
+        source = value.respond_to?(:to_hash) ? value.to_hash : value
+        return nil unless source.is_a?(Hash)
+
+        source[key] || source[key.to_s]
+      end
+
+      def valid_captured_at?(value)
+        return false unless value.is_a?(String)
+
+        match = CAPTURED_AT_REGEX.match(value)
+        return false unless match
+
+        year, month, day, hour, minute, second = match[:datetime].scan(/\d+/).map(&:to_i)
+
+        Date.valid_date?(year, month, day) && hour <= 23 && minute <= 59 && second <= 59
+      end
+    end
+
     attr_reader :events, :operations, :sandbox
 
     def initialize(token: nil, base_url: DEFAULT_BASE_URL, timeout: 30, user_agent: nil)
@@ -18,6 +89,7 @@ module PlainRouter
       api_client.user_agent = user_agent || "plainrouter-ruby/#{VERSION}"
 
       @events = OpenAPI::EventApi.new(api_client)
+      @events.singleton_class.prepend(EventsValidation)
       @operations = OpenAPI::OperationsApi.new(api_client)
       @sandbox = OpenAPI::SandboxApi.new(api_client)
     end

data/lib/plainrouter/openapi/api/action_dry_run_api_api.rb

@@ -0,0 +1,96 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'cgi'
+
+module PlainRouter::OpenAPI
+  class ActionDryRunApiApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Preview actions
+    # Evaluate a governed proposal for the approved account and preview each policy decision and execution diff without creating a batch or action.
+    # @param workspace [Integer] The workspace ID
+    # @param action_proposal_input [ActionProposalInput]
+    # @param [Hash] opts the optional parameters
+    # @return [ActionDryRunRead]
+    def actions_api_dry_run(workspace, action_proposal_input, opts = {})
+      data, _status_code, _headers = actions_api_dry_run_with_http_info(workspace, action_proposal_input, opts)
+      data
+    end
+
+    # Preview actions
+    # Evaluate a governed proposal for the approved account and preview each policy decision and execution diff without creating a batch or action.
+    # @param workspace [Integer] The workspace ID
+    # @param action_proposal_input [ActionProposalInput]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActionDryRunRead, Integer, Hash)>] ActionDryRunRead data, response status code and response headers
+    def actions_api_dry_run_with_http_info(workspace, action_proposal_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActionDryRunApiApi.actions_api_dry_run ...'
+      end
+      # verify the required parameter 'workspace' is set
+      if @api_client.config.client_side_validation && workspace.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace' when calling ActionDryRunApiApi.actions_api_dry_run"
+      end
+      # verify the required parameter 'action_proposal_input' is set
+      if @api_client.config.client_side_validation && action_proposal_input.nil?
+        fail ArgumentError, "Missing the required parameter 'action_proposal_input' when calling ActionDryRunApiApi.actions_api_dry_run"
+      end
+      # resource path
+      local_var_path = '/agent/workspaces/{workspace}/actions/dry-run'.sub('{workspace}', CGI.escape(workspace.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/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] || @api_client.object_to_http_body(action_proposal_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ActionDryRunRead'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['workspaceActionKey']
+
+      new_options = opts.merge(
+        :operation => :"ActionDryRunApiApi.actions_api_dry_run",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ActionDryRunApiApi#actions_api_dry_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/plainrouter/openapi/api/action_proposal_api_api.rb

@@ -0,0 +1,96 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'cgi'
+
+module PlainRouter::OpenAPI
+  class ActionProposalApiApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Propose actions
+    # Submit a governed proposal for an advertising account available to this workspace key. A matching idempotency key returns the saved batch.
+    # @param workspace [Integer] The workspace ID
+    # @param action_proposal_input [ActionProposalInput]
+    # @param [Hash] opts the optional parameters
+    # @return [ActionProposalRead]
+    def actions_api_propose(workspace, action_proposal_input, opts = {})
+      data, _status_code, _headers = actions_api_propose_with_http_info(workspace, action_proposal_input, opts)
+      data
+    end
+
+    # Propose actions
+    # Submit a governed proposal for an advertising account available to this workspace key. A matching idempotency key returns the saved batch.
+    # @param workspace [Integer] The workspace ID
+    # @param action_proposal_input [ActionProposalInput]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActionProposalRead, Integer, Hash)>] ActionProposalRead data, response status code and response headers
+    def actions_api_propose_with_http_info(workspace, action_proposal_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ActionProposalApiApi.actions_api_propose ...'
+      end
+      # verify the required parameter 'workspace' is set
+      if @api_client.config.client_side_validation && workspace.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace' when calling ActionProposalApiApi.actions_api_propose"
+      end
+      # verify the required parameter 'action_proposal_input' is set
+      if @api_client.config.client_side_validation && action_proposal_input.nil?
+        fail ArgumentError, "Missing the required parameter 'action_proposal_input' when calling ActionProposalApiApi.actions_api_propose"
+      end
+      # resource path
+      local_var_path = '/agent/workspaces/{workspace}/actions'.sub('{workspace}', CGI.escape(workspace.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/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] || @api_client.object_to_http_body(action_proposal_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ActionProposalRead'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['workspaceActionKey']
+
+      new_options = opts.merge(
+        :operation => :"ActionProposalApiApi.actions_api_propose",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ActionProposalApiApi#actions_api_propose\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end