plainrouter-sdk 0.2.0 → 0.6.0

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

@@ -0,0 +1,263 @@
+=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 AdTestApiApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List Tests and observed conversion event choices
+    # Lists scoped Tests, their loser pause candidate status and reasons, and observed conversion event choices with last-30-day recorded counts.
+    # @param workspace [Integer] The workspace ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page
+    # @option opts [Integer] :page Integer page from 1 through 10000000000000000; integer strings are accepted. Zero, negatives, fractions, non-numeric strings and booleans return 422 with a page field validation error.
+    # @return [AdTestListRead]
+    def actions_tests_api_index(workspace, opts = {})
+      data, _status_code, _headers = actions_tests_api_index_with_http_info(workspace, opts)
+      data
+    end
+
+    # List Tests and observed conversion event choices
+    # Lists scoped Tests, their loser pause candidate status and reasons, and observed conversion event choices with last-30-day recorded counts.
+    # @param workspace [Integer] The workspace ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page
+    # @option opts [Integer] :page Integer page from 1 through 10000000000000000; integer strings are accepted. Zero, negatives, fractions, non-numeric strings and booleans return 422 with a page field validation error.
+    # @return [Array<(AdTestListRead, Integer, Hash)>] AdTestListRead data, response status code and response headers
+    def actions_tests_api_index_with_http_info(workspace, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdTestApiApi.actions_tests_api_index ...'
+      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 AdTestApiApi.actions_tests_api_index"
+      end
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && !opts[:'per_page'].is_a?(String) && opts[:'per_page'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AdTestApiApi.actions_tests_api_index, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && !opts[:'per_page'].is_a?(String) && opts[:'per_page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AdTestApiApi.actions_tests_api_index, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && !opts[:'page'].is_a?(String) && opts[:'page'] > 10000000000000000
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AdTestApiApi.actions_tests_api_index, must be smaller than or equal to 10000000000000000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && !opts[:'page'].is_a?(String) && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AdTestApiApi.actions_tests_api_index, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/agent/workspaces/{workspace}/tests'.sub('{workspace}', CGI.escape(workspace.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # 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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AdTestListRead'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['testReader']
+
+      new_options = opts.merge(
+        :operation => :"AdTestApiApi.actions_tests_api_index",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdTestApiApi#actions_tests_api_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read a Test, verdict, and pause candidates
+    # Reads a scoped Test, its stored daily facts and verdict, and loser pause candidate status and reason; recorded counts rank members only within this Test.
+    # @param workspace [Integer] The workspace ID
+    # @param ad_test [String]
+    # @param [Hash] opts the optional parameters
+    # @return [AdTestShowRead]
+    def actions_tests_api_show(workspace, ad_test, opts = {})
+      data, _status_code, _headers = actions_tests_api_show_with_http_info(workspace, ad_test, opts)
+      data
+    end
+
+    # Read a Test, verdict, and pause candidates
+    # Reads a scoped Test, its stored daily facts and verdict, and loser pause candidate status and reason; recorded counts rank members only within this Test.
+    # @param workspace [Integer] The workspace ID
+    # @param ad_test [String]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AdTestShowRead, Integer, Hash)>] AdTestShowRead data, response status code and response headers
+    def actions_tests_api_show_with_http_info(workspace, ad_test, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdTestApiApi.actions_tests_api_show ...'
+      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 AdTestApiApi.actions_tests_api_show"
+      end
+      # verify the required parameter 'ad_test' is set
+      if @api_client.config.client_side_validation && ad_test.nil?
+        fail ArgumentError, "Missing the required parameter 'ad_test' when calling AdTestApiApi.actions_tests_api_show"
+      end
+      if @api_client.config.client_side_validation && ad_test.to_s.length > 26
+        fail ArgumentError, 'invalid value for "ad_test" when calling AdTestApiApi.actions_tests_api_show, the character length must be smaller than or equal to 26.'
+      end
+
+      if @api_client.config.client_side_validation && ad_test.to_s.length < 26
+        fail ArgumentError, 'invalid value for "ad_test" when calling AdTestApiApi.actions_tests_api_show, the character length must be greater than or equal to 26.'
+      end
+
+      pattern = Regexp.new(/^[0-7][0-9a-hjkmnp-tv-z]{25}$/)
+      if @api_client.config.client_side_validation && ad_test !~ pattern
+        fail ArgumentError, "invalid value for 'ad_test' when calling AdTestApiApi.actions_tests_api_show, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/agent/workspaces/{workspace}/tests/{ad_test}'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{ad_test}', CGI.escape(ad_test.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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AdTestShowRead'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['testReader']
+
+      new_options = opts.merge(
+        :operation => :"AdTestApiApi.actions_tests_api_show",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AdTestApiApi#actions_tests_api_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a judging Test
+    # Creates a judging Test with frozen event, settings, axis, and 2 to 4 ads from one mirrored ad set; it creates no proposal or Meta write.
+    # @param workspace [Integer] The workspace ID
+    # @param actions_tests_api_store_request [ActionsTestsApiStoreRequest] A Test using ads present in the selected mirrored Meta ad set.
+    # @param [Hash] opts the optional parameters
+    # @return [AdTestCreateRead]
+    def actions_tests_api_store(workspace, actions_tests_api_store_request, opts = {})
+      data, _status_code, _headers = actions_tests_api_store_with_http_info(workspace, actions_tests_api_store_request, opts)
+      data
+    end
+
+    # Create a judging Test
+    # Creates a judging Test with frozen event, settings, axis, and 2 to 4 ads from one mirrored ad set; it creates no proposal or Meta write.
+    # @param workspace [Integer] The workspace ID
+    # @param actions_tests_api_store_request [ActionsTestsApiStoreRequest] A Test using ads present in the selected mirrored Meta ad set.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AdTestCreateRead, Integer, Hash)>] AdTestCreateRead data, response status code and response headers
+    def actions_tests_api_store_with_http_info(workspace, actions_tests_api_store_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AdTestApiApi.actions_tests_api_store ...'
+      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 AdTestApiApi.actions_tests_api_store"
+      end
+      # verify the required parameter 'actions_tests_api_store_request' is set
+      if @api_client.config.client_side_validation && actions_tests_api_store_request.nil?
+        fail ArgumentError, "Missing the required parameter 'actions_tests_api_store_request' when calling AdTestApiApi.actions_tests_api_store"
+      end
+      # resource path
+      local_var_path = '/agent/workspaces/{workspace}/tests'.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(actions_tests_api_store_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AdTestCreateRead'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['testWriter']
+
+      new_options = opts.merge(
+        :operation => :"AdTestApiApi.actions_tests_api_store",
+        :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: AdTestApiApi#actions_tests_api_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+=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 AgentContextApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get agent context
+    # Read the authenticated agent and authorized account. With no active account, returns null and connection next steps.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; a different ID returns 422. An unbound key requires exactly one active available advertising account with an active connection; omission uses that account and a supplied ID must match it. Multiple active accounts return 422 even when account_id is supplied. With no active available account, a valid account_id is ignored and platform_ad_account is null.
+    # @option opts [Integer] :workspace_id Optional workspace grant selector. Required for credentials with multiple workspace grants; it must identify an authorized workspace.
+    # @return [AgentContext200Response]
+    def agent_context(opts = {})
+      data, _status_code, _headers = agent_context_with_http_info(opts)
+      data
+    end
+
+    # Get agent context
+    # Read the authenticated agent and authorized account. With no active account, returns null and connection next steps.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :account_id Optional positive account ID. A bound key may name only its own account; a different ID returns 422. An unbound key requires exactly one active available advertising account with an active connection; omission uses that account and a supplied ID must match it. Multiple active accounts return 422 even when account_id is supplied. With no active available account, a valid account_id is ignored and platform_ad_account is null.
+    # @option opts [Integer] :workspace_id Optional workspace grant selector. Required for credentials with multiple workspace grants; it must identify an authorized workspace.
+    # @return [Array<(AgentContext200Response, Integer, Hash)>] AgentContext200Response data, response status code and response headers
+    def agent_context_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentContextApi.agent_context ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'account_id'].nil? && !opts[:'account_id'].is_a?(String) && opts[:'account_id'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"account_id"]" when calling AgentContextApi.agent_context, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'workspace_id'].nil? && !opts[:'workspace_id'].is_a?(String) && opts[:'workspace_id'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"workspace_id"]" when calling AgentContextApi.agent_context, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/agent/context'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
+      query_params[:'workspace_id'] = opts[:'workspace_id'] if !opts[:'workspace_id'].nil?
+
+      # 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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AgentContext200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['agentContextOAuth', 'agentContextKey']
+
+      new_options = opts.merge(
+        :operation => :"AgentContextApi.agent_context",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AgentContextApi#agent_context\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+=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 CookieDeclarationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Read the public cookie declaration
+    # Public on every plan. Returns latest completed scan metadata, never values. Invalid keys return 404 before the 300/minute per-key limiter.
+    # @param publishable_key [String] Workspace publishable key from the customer page source; pk_live_ followed by 32 alphanumeric characters.
+    # @param [Hash] opts the optional parameters
+    # @return [CookieDeclaration]
+    def get_cookie_declaration(publishable_key, opts = {})
+      data, _status_code, _headers = get_cookie_declaration_with_http_info(publishable_key, opts)
+      data
+    end
+
+    # Read the public cookie declaration
+    # Public on every plan. Returns latest completed scan metadata, never values. Invalid keys return 404 before the 300/minute per-key limiter.
+    # @param publishable_key [String] Workspace publishable key from the customer page source; pk_live_ followed by 32 alphanumeric characters.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CookieDeclaration, Integer, Hash)>] CookieDeclaration data, response status code and response headers
+    def get_cookie_declaration_with_http_info(publishable_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CookieDeclarationApi.get_cookie_declaration ...'
+      end
+      # verify the required parameter 'publishable_key' is set
+      if @api_client.config.client_side_validation && publishable_key.nil?
+        fail ArgumentError, "Missing the required parameter 'publishable_key' when calling CookieDeclarationApi.get_cookie_declaration"
+      end
+      pattern = Regexp.new(/^pk_live_[A-Za-z0-9]{32}$/)
+      if @api_client.config.client_side_validation && publishable_key !~ pattern
+        fail ArgumentError, "invalid value for 'publishable_key' when calling CookieDeclarationApi.get_cookie_declaration, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/cookie-declarations/{publishableKey}'.sub('{publishableKey}', CGI.escape(publishable_key.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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CookieDeclaration'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"CookieDeclarationApi.get_cookie_declaration",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CookieDeclarationApi#get_cookie_declaration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end