plainrouter-sdk 0.2.0 → 0.5.0

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

@@ -0,0 +1,306 @@
+=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 DeploymentPlanApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Copy a failed plan to a new draft
+    # Copy failed plan content and stored integer budgets into a fresh draft. History stays unchanged; validate budgets and submit again with a new intent.
+    # @param workspace [Integer] The workspace ID
+    # @param deployment_plan [String]
+    # @param [Hash] opts the optional parameters
+    # @return [PlanCopyRead]
+    def launch_plans_copy(workspace, deployment_plan, opts = {})
+      data, _status_code, _headers = launch_plans_copy_with_http_info(workspace, deployment_plan, opts)
+      data
+    end
+
+    # Copy a failed plan to a new draft
+    # Copy failed plan content and stored integer budgets into a fresh draft. History stays unchanged; validate budgets and submit again with a new intent.
+    # @param workspace [Integer] The workspace ID
+    # @param deployment_plan [String]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PlanCopyRead, Integer, Hash)>] PlanCopyRead data, response status code and response headers
+    def launch_plans_copy_with_http_info(workspace, deployment_plan, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DeploymentPlanApi.launch_plans_copy ...'
+      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 DeploymentPlanApi.launch_plans_copy"
+      end
+      # verify the required parameter 'deployment_plan' is set
+      if @api_client.config.client_side_validation && deployment_plan.nil?
+        fail ArgumentError, "Missing the required parameter 'deployment_plan' when calling DeploymentPlanApi.launch_plans_copy"
+      end
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/plans/{deployment_plan}/copy'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{deployment_plan}', CGI.escape(deployment_plan.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] || 'PlanCopyRead'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['planWriter']
+
+      new_options = opts.merge(
+        :operation => :"DeploymentPlanApi.launch_plans_copy",
+        :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: DeploymentPlanApi#launch_plans_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Execute a deployment plan
+    # Create or replay a governed Launch intent using the reviewed plan's review_version. Changed versions are refused before intent creation or staging.
+    # @param workspace [Integer] The workspace ID
+    # @param deployment_plan [String]
+    # @param execute_deployment_plan_request [ExecuteDeploymentPlanRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [LaunchIntentRead]
+    def launch_plans_execute(workspace, deployment_plan, execute_deployment_plan_request, opts = {})
+      data, _status_code, _headers = launch_plans_execute_with_http_info(workspace, deployment_plan, execute_deployment_plan_request, opts)
+      data
+    end
+
+    # Execute a deployment plan
+    # Create or replay a governed Launch intent using the reviewed plan&#39;s review_version. Changed versions are refused before intent creation or staging.
+    # @param workspace [Integer] The workspace ID
+    # @param deployment_plan [String]
+    # @param execute_deployment_plan_request [ExecuteDeploymentPlanRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LaunchIntentRead, Integer, Hash)>] LaunchIntentRead data, response status code and response headers
+    def launch_plans_execute_with_http_info(workspace, deployment_plan, execute_deployment_plan_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DeploymentPlanApi.launch_plans_execute ...'
+      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 DeploymentPlanApi.launch_plans_execute"
+      end
+      # verify the required parameter 'deployment_plan' is set
+      if @api_client.config.client_side_validation && deployment_plan.nil?
+        fail ArgumentError, "Missing the required parameter 'deployment_plan' when calling DeploymentPlanApi.launch_plans_execute"
+      end
+      # verify the required parameter 'execute_deployment_plan_request' is set
+      if @api_client.config.client_side_validation && execute_deployment_plan_request.nil?
+        fail ArgumentError, "Missing the required parameter 'execute_deployment_plan_request' when calling DeploymentPlanApi.launch_plans_execute"
+      end
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/plans/{deployment_plan}/execute'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{deployment_plan}', CGI.escape(deployment_plan.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(execute_deployment_plan_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LaunchIntentRead'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['planWriter']
+
+      new_options = opts.merge(
+        :operation => :"DeploymentPlanApi.launch_plans_execute",
+        :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: DeploymentPlanApi#launch_plans_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List deployment plans
+    # Read plans for the approved ad account with their current review_version. Pass the version from the plan you reviewed when executing.
+    # @param workspace [Integer] The workspace ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page  (default to 25)
+    # @return [LaunchPlansIndex200Response]
+    def launch_plans_index(workspace, opts = {})
+      data, _status_code, _headers = launch_plans_index_with_http_info(workspace, opts)
+      data
+    end
+
+    # List deployment plans
+    # Read plans for the approved ad account with their current review_version. Pass the version from the plan you reviewed when executing.
+    # @param workspace [Integer] The workspace ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :per_page  (default to 25)
+    # @return [Array<(LaunchPlansIndex200Response, Integer, Hash)>] LaunchPlansIndex200Response data, response status code and response headers
+    def launch_plans_index_with_http_info(workspace, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DeploymentPlanApi.launch_plans_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 DeploymentPlanApi.launch_plans_index"
+      end
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/plans'.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?
+
+      # 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] || 'LaunchPlansIndex200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['planReader']
+
+      new_options = opts.merge(
+        :operation => :"DeploymentPlanApi.launch_plans_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: DeploymentPlanApi#launch_plans_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read a deployment plan
+    # Read plans for the approved ad account with their current review_version. Pass the version from the plan you reviewed when executing.
+    # @param workspace [Integer] The workspace ID
+    # @param deployment_plan [String]
+    # @param [Hash] opts the optional parameters
+    # @return [LaunchPlansShow200Response]
+    def launch_plans_show(workspace, deployment_plan, opts = {})
+      data, _status_code, _headers = launch_plans_show_with_http_info(workspace, deployment_plan, opts)
+      data
+    end
+
+    # Read a deployment plan
+    # Read plans for the approved ad account with their current review_version. Pass the version from the plan you reviewed when executing.
+    # @param workspace [Integer] The workspace ID
+    # @param deployment_plan [String]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LaunchPlansShow200Response, Integer, Hash)>] LaunchPlansShow200Response data, response status code and response headers
+    def launch_plans_show_with_http_info(workspace, deployment_plan, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DeploymentPlanApi.launch_plans_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 DeploymentPlanApi.launch_plans_show"
+      end
+      # verify the required parameter 'deployment_plan' is set
+      if @api_client.config.client_side_validation && deployment_plan.nil?
+        fail ArgumentError, "Missing the required parameter 'deployment_plan' when calling DeploymentPlanApi.launch_plans_show"
+      end
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/plans/{deployment_plan}'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{deployment_plan}', CGI.escape(deployment_plan.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] || 'LaunchPlansShow200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['planReader']
+
+      new_options = opts.merge(
+        :operation => :"DeploymentPlanApi.launch_plans_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: DeploymentPlanApi#launch_plans_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+=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 MetaInventoryExposureApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Compare Meta metrics with counted arrivals
+    # Compare daily Meta metrics with PlainRouter arrivals in the account timezone, within plan retention. Unknown object IDs are never exposed.
+    # @param workspace [Integer] The workspace ID
+    # @param account_id [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :start_date
+    # @option opts [Date] :end_date
+    # @option opts [String] :campaign_id
+    # @option opts [String] :adset_id
+    # @option opts [String] :ad_id
+    # @option opts [Boolean] :include_changes
+    # @return [GetInventoryMetrics200Response]
+    def get_inventory_metrics(workspace, account_id, opts = {})
+      data, _status_code, _headers = get_inventory_metrics_with_http_info(workspace, account_id, opts)
+      data
+    end
+
+    # Compare Meta metrics with counted arrivals
+    # Compare daily Meta metrics with PlainRouter arrivals in the account timezone, within plan retention. Unknown object IDs are never exposed.
+    # @param workspace [Integer] The workspace ID
+    # @param account_id [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :start_date
+    # @option opts [Date] :end_date
+    # @option opts [String] :campaign_id
+    # @option opts [String] :adset_id
+    # @option opts [String] :ad_id
+    # @option opts [Boolean] :include_changes
+    # @return [Array<(GetInventoryMetrics200Response, Integer, Hash)>] GetInventoryMetrics200Response data, response status code and response headers
+    def get_inventory_metrics_with_http_info(workspace, account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MetaInventoryExposureApi.get_inventory_metrics ...'
+      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 MetaInventoryExposureApi.get_inventory_metrics"
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling MetaInventoryExposureApi.get_inventory_metrics"
+      end
+      if @api_client.config.client_side_validation && !opts[:'campaign_id'].nil? && opts[:'campaign_id'].to_s.length > 128
+        fail ArgumentError, 'invalid value for "opts[:"campaign_id"]" when calling MetaInventoryExposureApi.get_inventory_metrics, the character length must be smaller than or equal to 128.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'adset_id'].nil? && opts[:'adset_id'].to_s.length > 128
+        fail ArgumentError, 'invalid value for "opts[:"adset_id"]" when calling MetaInventoryExposureApi.get_inventory_metrics, the character length must be smaller than or equal to 128.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'ad_id'].nil? && opts[:'ad_id'].to_s.length > 128
+        fail ArgumentError, 'invalid value for "opts[:"ad_id"]" when calling MetaInventoryExposureApi.get_inventory_metrics, the character length must be smaller than or equal to 128.'
+      end
+
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/ad-accounts/{account_id}/inventory/metrics'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{account_id}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'campaign_id'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
+      query_params[:'adset_id'] = opts[:'adset_id'] if !opts[:'adset_id'].nil?
+      query_params[:'ad_id'] = opts[:'ad_id'] if !opts[:'ad_id'].nil?
+      query_params[:'include_changes'] = opts[:'include_changes'] if !opts[:'include_changes'].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] || 'GetInventoryMetrics200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['workspaceInventoryKey']
+
+      new_options = opts.merge(
+        :operation => :"MetaInventoryExposureApi.get_inventory_metrics",
+        :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: MetaInventoryExposureApi#get_inventory_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/plainrouter/openapi/configuration.rb

@@ -269,6 +269,48 @@ module PlainRouter::OpenAPI
             key: 'Authorization',
             value: "Bearer #{access_token_with_refresh}"
           },
+        'planWriter' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
+        'workspaceInventoryKey' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
+        'planReader' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
+        'creativeWriter' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
+        'testReader' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
+        'testWriter' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
       }
     end
 

data/lib/plainrouter/openapi/models/action_current_disposition.rb

@@ -17,6 +17,8 @@ module PlainRouter::OpenAPI
   class ActionCurrentDisposition < ApiModelBase
     attr_accessor :receipt_status
 
+    attr_accessor :outcome_payload
+
     attr_accessor :outcome_status
 
     attr_accessor :outcome_reason_code
@@ -55,6 +57,7 @@ module PlainRouter::OpenAPI
     def self.attribute_map
       {
         :'receipt_status' => :'receipt_status',
+        :'outcome_payload' => :'outcome_payload',
         :'outcome_status' => :'outcome_status',
         :'outcome_reason_code' => :'outcome_reason_code',
         :'outcome_checked_at' => :'outcome_checked_at',
@@ -78,6 +81,7 @@ module PlainRouter::OpenAPI
     def self.openapi_types
       {
         :'receipt_status' => :'String',
+        :'outcome_payload' => :'ActionCurrentDispositionOutcomePayload',
         :'outcome_status' => :'String',
         :'outcome_reason_code' => :'String',
         :'outcome_checked_at' => :'Time',
@@ -91,6 +95,7 @@ module PlainRouter::OpenAPI
     def self.openapi_nullable
       Set.new([
         :'receipt_status',
+        :'outcome_payload',
         :'outcome_status',
         :'outcome_reason_code',
         :'outcome_checked_at',
@@ -121,6 +126,12 @@ module PlainRouter::OpenAPI
         self.receipt_status = nil
       end
 
+      if attributes.key?(:'outcome_payload')
+        self.outcome_payload = attributes[:'outcome_payload']
+      else
+        self.outcome_payload = nil
+      end
+
       if attributes.key?(:'outcome_status')
         self.outcome_status = attributes[:'outcome_status']
       else
@@ -230,6 +241,7 @@ module PlainRouter::OpenAPI
       return true if self.equal?(o)
       self.class == o.class &&
           receipt_status == o.receipt_status &&
+          outcome_payload == o.outcome_payload &&
           outcome_status == o.outcome_status &&
           outcome_reason_code == o.outcome_reason_code &&
           outcome_checked_at == o.outcome_checked_at &&
@@ -247,7 +259,7 @@ module PlainRouter::OpenAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [receipt_status, outcome_status, outcome_reason_code, outcome_checked_at, compensation_reason_code, recovery_disposition, late_restored].hash
+      [receipt_status, outcome_payload, outcome_status, outcome_reason_code, outcome_checked_at, compensation_reason_code, recovery_disposition, late_restored].hash
     end
 
     # Builds the object from hash