plainrouter-sdk 0.5.0 → 0.6.0

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

@@ -172,7 +172,9 @@ module PlainRouter::OpenAPI
     # 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)
+    # @option opts [Integer] :cursor Continue using next_cursor with the same filters; rule lists use an immutable rule ID, other lists an offset or object ID.
+    # @option opts [Integer] :per_page Maximum complete rows; the byte budget may return fewer. Defaults to 25. (default to 25)
+    # @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. (default to 1)
     # @return [LaunchPlansIndex200Response]
     def launch_plans_index(workspace, opts = {})
       data, _status_code, _headers = launch_plans_index_with_http_info(workspace, opts)
@@ -183,7 +185,9 @@ module PlainRouter::OpenAPI
     # 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)
+    # @option opts [Integer] :cursor Continue using next_cursor with the same filters; rule lists use an immutable rule ID, other lists an offset or object ID.
+    # @option opts [Integer] :per_page Maximum complete rows; the byte budget may return fewer. Defaults to 25. (default to 25)
+    # @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. (default to 1)
     # @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
@@ -193,12 +197,26 @@ module PlainRouter::OpenAPI
       if @api_client.config.client_side_validation && workspace.nil?
         fail ArgumentError, "Missing the required parameter 'workspace' when calling DeploymentPlanApi.launch_plans_index"
       end
+      if @api_client.config.client_side_validation && !opts[:'cursor'].nil? && !opts[:'cursor'].is_a?(String) && opts[:'cursor'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"cursor"]" when calling DeploymentPlanApi.launch_plans_index, must be greater than or equal to 0.'
+      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 DeploymentPlanApi.launch_plans_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 DeploymentPlanApi.launch_plans_index, must be greater than or equal to 1.'
+      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[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
       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] || {}
@@ -239,6 +257,8 @@ module PlainRouter::OpenAPI
     # @param workspace [Integer] The workspace ID
     # @param deployment_plan [String]
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :cursor Continue using next_cursor with the same filters; rule lists use an immutable rule ID, other lists an offset or object ID.
+    # @option opts [Integer] :limit Maximum complete rows; the byte budget may return fewer. Defaults to 5. (default to 5)
     # @return [LaunchPlansShow200Response]
     def launch_plans_show(workspace, deployment_plan, opts = {})
       data, _status_code, _headers = launch_plans_show_with_http_info(workspace, deployment_plan, opts)
@@ -250,6 +270,8 @@ module PlainRouter::OpenAPI
     # @param workspace [Integer] The workspace ID
     # @param deployment_plan [String]
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :cursor Continue using next_cursor with the same filters; rule lists use an immutable rule ID, other lists an offset or object ID.
+    # @option opts [Integer] :limit Maximum complete rows; the byte budget may return fewer. Defaults to 5. (default to 5)
     # @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
@@ -263,11 +285,25 @@ module PlainRouter::OpenAPI
       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
+      if @api_client.config.client_side_validation && !opts[:'cursor'].nil? && !opts[:'cursor'].is_a?(String) && opts[:'cursor'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"cursor"]" when calling DeploymentPlanApi.launch_plans_show, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && !opts[:'limit'].is_a?(String) && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DeploymentPlanApi.launch_plans_show, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && !opts[:'limit'].is_a?(String) && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling DeploymentPlanApi.launch_plans_show, must be greater than or equal to 1.'
+      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] || {}
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -302,5 +338,224 @@ module PlainRouter::OpenAPI
       end
       return data, status_code, headers
     end
+
+    # Create a deployment plan
+    # Create or edit a draft deployment plan for the authorized advertising account. Review and validate the plan before submitting any provider writes.
+    # @param workspace [Integer] The workspace ID
+    # @param store_deployment_plan_request [StoreDeploymentPlanRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [LaunchPlansStore201Response]
+    def launch_plans_store(workspace, store_deployment_plan_request, opts = {})
+      data, _status_code, _headers = launch_plans_store_with_http_info(workspace, store_deployment_plan_request, opts)
+      data
+    end
+
+    # Create a deployment plan
+    # Create or edit a draft deployment plan for the authorized advertising account. Review and validate the plan before submitting any provider writes.
+    # @param workspace [Integer] The workspace ID
+    # @param store_deployment_plan_request [StoreDeploymentPlanRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LaunchPlansStore201Response, Integer, Hash)>] LaunchPlansStore201Response data, response status code and response headers
+    def launch_plans_store_with_http_info(workspace, store_deployment_plan_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DeploymentPlanApi.launch_plans_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 DeploymentPlanApi.launch_plans_store"
+      end
+      # verify the required parameter 'store_deployment_plan_request' is set
+      if @api_client.config.client_side_validation && store_deployment_plan_request.nil?
+        fail ArgumentError, "Missing the required parameter 'store_deployment_plan_request' when calling DeploymentPlanApi.launch_plans_store"
+      end
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/plans'.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(store_deployment_plan_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LaunchPlansStore201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['workspaceSecret']
+
+      new_options = opts.merge(
+        :operation => :"DeploymentPlanApi.launch_plans_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: DeploymentPlanApi#launch_plans_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a deployment plan
+    # Create or edit a draft deployment plan for the authorized advertising account. Review and validate the plan before submitting any provider writes.
+    # @param workspace [Integer] The workspace ID
+    # @param deployment_plan [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateDeploymentPlanRequest] :update_deployment_plan_request
+    # @return [LaunchPlansStore201Response]
+    def launch_plans_update(workspace, deployment_plan, opts = {})
+      data, _status_code, _headers = launch_plans_update_with_http_info(workspace, deployment_plan, opts)
+      data
+    end
+
+    # Update a deployment plan
+    # Create or edit a draft deployment plan for the authorized advertising account. Review and validate the plan before submitting any provider writes.
+    # @param workspace [Integer] The workspace ID
+    # @param deployment_plan [String]
+    # @param [Hash] opts the optional parameters
+    # @option opts [UpdateDeploymentPlanRequest] :update_deployment_plan_request
+    # @return [Array<(LaunchPlansStore201Response, Integer, Hash)>] LaunchPlansStore201Response data, response status code and response headers
+    def launch_plans_update_with_http_info(workspace, deployment_plan, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DeploymentPlanApi.launch_plans_update ...'
+      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_update"
+      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_update"
+      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']
+      # 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(opts[:'update_deployment_plan_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LaunchPlansStore201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['workspaceSecret']
+
+      new_options = opts.merge(
+        :operation => :"DeploymentPlanApi.launch_plans_update",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DeploymentPlanApi#launch_plans_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Validate a deployment plan
+    # Validate a plan without provider writes. Reuse a ready Meta video in the same ad account; plans needing a new video upload are refused.
+    # @param workspace [Integer] The workspace ID
+    # @param deployment_plan [String]
+    # @param [Hash] opts the optional parameters
+    # @return [LaunchPlansShow200Response]
+    def launch_plans_validate(workspace, deployment_plan, opts = {})
+      data, _status_code, _headers = launch_plans_validate_with_http_info(workspace, deployment_plan, opts)
+      data
+    end
+
+    # Validate a deployment plan
+    # Validate a plan without provider writes. Reuse a ready Meta video in the same ad account; plans needing a new video upload are refused.
+    # @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_validate_with_http_info(workspace, deployment_plan, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DeploymentPlanApi.launch_plans_validate ...'
+      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_validate"
+      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_validate"
+      end
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/plans/{deployment_plan}/validate'.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] || ['planWriter']
+
+      new_options = opts.merge(
+        :operation => :"DeploymentPlanApi.launch_plans_validate",
+        :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_validate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

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

@@ -0,0 +1,142 @@
+=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 DraftBatchFileImportApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Import a Launcher draft batch
+    # Import a CSV or spreadsheet into a governed Launcher draft batch for the workspace and account authorized by the execution key.
+    # @param file [File]
+    # @param source_adset_id [String]
+    # @param source_ad_id [String]
+    # @param mode [DraftBatchMode]
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :folder_to_adset
+    # @option opts [Boolean] :grouping_enabled
+    # @option opts [Integer] :account_id
+    # @option opts [Integer] :workspace_id
+    # @return [Hash<String, Object>]
+    def launcher_file_import(file, source_adset_id, source_ad_id, mode, opts = {})
+      data, _status_code, _headers = launcher_file_import_with_http_info(file, source_adset_id, source_ad_id, mode, opts)
+      data
+    end
+
+    # Import a Launcher draft batch
+    # Import a CSV or spreadsheet into a governed Launcher draft batch for the workspace and account authorized by the execution key.
+    # @param file [File]
+    # @param source_adset_id [String]
+    # @param source_ad_id [String]
+    # @param mode [DraftBatchMode]
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :folder_to_adset
+    # @option opts [Boolean] :grouping_enabled
+    # @option opts [Integer] :account_id
+    # @option opts [Integer] :workspace_id
+    # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
+    def launcher_file_import_with_http_info(file, source_adset_id, source_ad_id, mode, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DraftBatchFileImportApi.launcher_file_import ...'
+      end
+      # verify the required parameter 'file' is set
+      if @api_client.config.client_side_validation && file.nil?
+        fail ArgumentError, "Missing the required parameter 'file' when calling DraftBatchFileImportApi.launcher_file_import"
+      end
+      # verify the required parameter 'source_adset_id' is set
+      if @api_client.config.client_side_validation && source_adset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'source_adset_id' when calling DraftBatchFileImportApi.launcher_file_import"
+      end
+      pattern = Regexp.new(/^[0-9]+$/)
+      if @api_client.config.client_side_validation && source_adset_id !~ pattern
+        fail ArgumentError, "invalid value for 'source_adset_id' when calling DraftBatchFileImportApi.launcher_file_import, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'source_ad_id' is set
+      if @api_client.config.client_side_validation && source_ad_id.nil?
+        fail ArgumentError, "Missing the required parameter 'source_ad_id' when calling DraftBatchFileImportApi.launcher_file_import"
+      end
+      pattern = Regexp.new(/^[0-9]+$/)
+      if @api_client.config.client_side_validation && source_ad_id !~ pattern
+        fail ArgumentError, "invalid value for 'source_ad_id' when calling DraftBatchFileImportApi.launcher_file_import, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'mode' is set
+      if @api_client.config.client_side_validation && mode.nil?
+        fail ArgumentError, "Missing the required parameter 'mode' when calling DraftBatchFileImportApi.launcher_file_import"
+      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 DraftBatchFileImportApi.launcher_file_import, 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 DraftBatchFileImportApi.launcher_file_import, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/mcp/launcher/import'
+
+      # 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(['multipart/form-data'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['file'] = file
+      form_params['source_adset_id'] = source_adset_id
+      form_params['source_ad_id'] = source_ad_id
+      form_params['mode'] = mode
+      form_params['folder_to_adset'] = opts[:'folder_to_adset'] if !opts[:'folder_to_adset'].nil?
+      form_params['grouping_enabled'] = opts[:'grouping_enabled'] if !opts[:'grouping_enabled'].nil?
+      form_params['account_id'] = opts[:'account_id'] if !opts[:'account_id'].nil?
+      form_params['workspace_id'] = opts[:'workspace_id'] if !opts[:'workspace_id'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Hash<String, Object>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['workspaceSecret']
+
+      new_options = opts.merge(
+        :operation => :"DraftBatchFileImportApi.launcher_file_import",
+        :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: DraftBatchFileImportApi#launcher_file_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end