plainrouter-sdk 0.2.0 → 0.6.0

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

@@ -0,0 +1,422 @@
+=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 CreativeApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List workspace creatives
+    # Read complete workspace creative rows within the shared MCP byte budget. Continue with next_cursor as cursor in the same workspace.
+    # @param workspace [Integer] The workspace ID
+    # @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] :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 [LaunchCreativesIndex200Response]
+    def launch_creatives_index(workspace, opts = {})
+      data, _status_code, _headers = launch_creatives_index_with_http_info(workspace, opts)
+      data
+    end
+
+    # List workspace creatives
+    # Read complete workspace creative rows within the shared MCP byte budget. Continue with next_cursor as cursor in the same workspace.
+    # @param workspace [Integer] The workspace ID
+    # @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] :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<(LaunchCreativesIndex200Response, Integer, Hash)>] LaunchCreativesIndex200Response data, response status code and response headers
+    def launch_creatives_index_with_http_info(workspace, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CreativeApi.launch_creatives_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 CreativeApi.launch_creatives_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 CreativeApi.launch_creatives_index, must be greater than or equal to 0.'
+      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 CreativeApi.launch_creatives_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 CreativeApi.launch_creatives_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 CreativeApi.launch_creatives_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 CreativeApi.launch_creatives_index, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/creatives'.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] || {}
+      # 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] || 'LaunchCreativesIndex200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['workspaceSecret']
+
+      new_options = opts.merge(
+        :operation => :"CreativeApi.launch_creatives_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: CreativeApi#launch_creatives_index\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read a workspace creative
+    # Read a creative or change its approval status within the authorized workspace. Creative content and provider submission remain separate operations.
+    # @param workspace [Integer] The workspace ID
+    # @param creative [String]
+    # @param [Hash] opts the optional parameters
+    # @return [LaunchCreativesStatus200Response]
+    def launch_creatives_show(workspace, creative, opts = {})
+      data, _status_code, _headers = launch_creatives_show_with_http_info(workspace, creative, opts)
+      data
+    end
+
+    # Read a workspace creative
+    # Read a creative or change its approval status within the authorized workspace. Creative content and provider submission remain separate operations.
+    # @param workspace [Integer] The workspace ID
+    # @param creative [String]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LaunchCreativesStatus200Response, Integer, Hash)>] LaunchCreativesStatus200Response data, response status code and response headers
+    def launch_creatives_show_with_http_info(workspace, creative, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CreativeApi.launch_creatives_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 CreativeApi.launch_creatives_show"
+      end
+      # verify the required parameter 'creative' is set
+      if @api_client.config.client_side_validation && creative.nil?
+        fail ArgumentError, "Missing the required parameter 'creative' when calling CreativeApi.launch_creatives_show"
+      end
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/creatives/{creative}'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{creative}', CGI.escape(creative.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] || 'LaunchCreativesStatus200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['workspaceSecret']
+
+      new_options = opts.merge(
+        :operation => :"CreativeApi.launch_creatives_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: CreativeApi#launch_creatives_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a workspace creative status
+    # Read a creative or change its approval status within the authorized workspace. Creative content and provider submission remain separate operations.
+    # @param workspace [Integer] The workspace ID
+    # @param creative [String]
+    # @param update_creative_status_request [UpdateCreativeStatusRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [LaunchCreativesStatus200Response]
+    def launch_creatives_status(workspace, creative, update_creative_status_request, opts = {})
+      data, _status_code, _headers = launch_creatives_status_with_http_info(workspace, creative, update_creative_status_request, opts)
+      data
+    end
+
+    # Update a workspace creative status
+    # Read a creative or change its approval status within the authorized workspace. Creative content and provider submission remain separate operations.
+    # @param workspace [Integer] The workspace ID
+    # @param creative [String]
+    # @param update_creative_status_request [UpdateCreativeStatusRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LaunchCreativesStatus200Response, Integer, Hash)>] LaunchCreativesStatus200Response data, response status code and response headers
+    def launch_creatives_status_with_http_info(workspace, creative, update_creative_status_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CreativeApi.launch_creatives_status ...'
+      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 CreativeApi.launch_creatives_status"
+      end
+      # verify the required parameter 'creative' is set
+      if @api_client.config.client_side_validation && creative.nil?
+        fail ArgumentError, "Missing the required parameter 'creative' when calling CreativeApi.launch_creatives_status"
+      end
+      # verify the required parameter 'update_creative_status_request' is set
+      if @api_client.config.client_side_validation && update_creative_status_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_creative_status_request' when calling CreativeApi.launch_creatives_status"
+      end
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/creatives/{creative}/status'.sub('{workspace}', CGI.escape(workspace.to_s)).sub('{creative}', CGI.escape(creative.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(update_creative_status_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LaunchCreativesStatus200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['workspaceSecret']
+
+      new_options = opts.merge(
+        :operation => :"CreativeApi.launch_creatives_status",
+        :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: CreativeApi#launch_creatives_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Upload a creative
+    # Store a creative in the credential-bound workspace. Set generator, generator_job and parent_creative tags for output from an outside tool.
+    # @param workspace [Integer] The workspace ID
+    # @param file [File] JPEG, PNG, MP4 or QuickTime bytes, at most 4 GiB.
+    # @param [Hash] opts the optional parameters
+    # @option opts [StoreCreativeRequestTags] :tags
+    # @option opts [String] :source_ref
+    # @return [CreativeIntakeRead]
+    def store_creative(workspace, file, opts = {})
+      data, _status_code, _headers = store_creative_with_http_info(workspace, file, opts)
+      data
+    end
+
+    # Upload a creative
+    # Store a creative in the credential-bound workspace. Set generator, generator_job and parent_creative tags for output from an outside tool.
+    # @param workspace [Integer] The workspace ID
+    # @param file [File] JPEG, PNG, MP4 or QuickTime bytes, at most 4 GiB.
+    # @param [Hash] opts the optional parameters
+    # @option opts [StoreCreativeRequestTags] :tags
+    # @option opts [String] :source_ref
+    # @return [Array<(CreativeIntakeRead, Integer, Hash)>] CreativeIntakeRead data, response status code and response headers
+    def store_creative_with_http_info(workspace, file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CreativeApi.store_creative ...'
+      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 CreativeApi.store_creative"
+      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 CreativeApi.store_creative"
+      end
+      if @api_client.config.client_side_validation && !opts[:'source_ref'].nil? && opts[:'source_ref'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"source_ref"]" when calling CreativeApi.store_creative, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/creatives'.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(['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['tags'] = opts[:'tags'] if !opts[:'tags'].nil?
+      form_params['source_ref'] = opts[:'source_ref'] if !opts[:'source_ref'].nil?
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreativeIntakeRead'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['creativeWriter']
+
+      new_options = opts.merge(
+        :operation => :"CreativeApi.store_creative",
+        :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: CreativeApi#store_creative\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Store a creative from a URL
+    # Store a creative in the credential-bound workspace. Set generator, generator_job and parent_creative tags for output from an outside tool.
+    # @param workspace [Integer] The workspace ID
+    # @param store_creative_from_url_request [StoreCreativeFromUrlRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [CreativeIntakeRead]
+    def store_creative_from_url(workspace, store_creative_from_url_request, opts = {})
+      data, _status_code, _headers = store_creative_from_url_with_http_info(workspace, store_creative_from_url_request, opts)
+      data
+    end
+
+    # Store a creative from a URL
+    # Store a creative in the credential-bound workspace. Set generator, generator_job and parent_creative tags for output from an outside tool.
+    # @param workspace [Integer] The workspace ID
+    # @param store_creative_from_url_request [StoreCreativeFromUrlRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreativeIntakeRead, Integer, Hash)>] CreativeIntakeRead data, response status code and response headers
+    def store_creative_from_url_with_http_info(workspace, store_creative_from_url_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CreativeApi.store_creative_from_url ...'
+      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 CreativeApi.store_creative_from_url"
+      end
+      # verify the required parameter 'store_creative_from_url_request' is set
+      if @api_client.config.client_side_validation && store_creative_from_url_request.nil?
+        fail ArgumentError, "Missing the required parameter 'store_creative_from_url_request' when calling CreativeApi.store_creative_from_url"
+      end
+      # resource path
+      local_var_path = '/workspaces/{workspace}/admin/creatives/from-url'.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_creative_from_url_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreativeIntakeRead'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['creativeWriter']
+
+      new_options = opts.merge(
+        :operation => :"CreativeApi.store_creative_from_url",
+        :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: CreativeApi#store_creative_from_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end