tachain-sdk 0.1.0 → 0.1.1

data/lib/tachain-sdk/api/api_process_route_api.rb

@@ -0,0 +1,414 @@
+=begin
+#Tactic Chain Public API
+
+#Public integration endpoints. Set your own base URL and credential before calling.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'cgi'
+
+module TachainSdk
+  class ApiProcessRouteApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 软删除加工路线；历史单据保持其已有引用，新建业务不可再选择该路线。
+    # 
+    # @param x_credential_type [String] Use 'Token' with bearer authorization, or 'API Key' with signed API key headers. This header is mandatory in the deployed API.
+    # @param [Hash] opts the optional parameters
+    # @option opts [ApiCatalogDeleteRequest] :api_catalog_delete_request 
+    # @return [PutV1DeliveryReturnReceipt200Response]
+    def delete_v1_process_route_delete(x_credential_type, opts = {})
+      data, _status_code, _headers = delete_v1_process_route_delete_with_http_info(x_credential_type, opts)
+      data
+    end
+
+    # 软删除加工路线；历史单据保持其已有引用，新建业务不可再选择该路线。
+    # 
+    # @param x_credential_type [String] Use 'Token' with bearer authorization, or 'API Key' with signed API key headers. This header is mandatory in the deployed API.
+    # @param [Hash] opts the optional parameters
+    # @option opts [ApiCatalogDeleteRequest] :api_catalog_delete_request 
+    # @return [Array<(PutV1DeliveryReturnReceipt200Response, Integer, Hash)>] PutV1DeliveryReturnReceipt200Response data, response status code and response headers
+    def delete_v1_process_route_delete_with_http_info(x_credential_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiProcessRouteApi.delete_v1_process_route_delete ...'
+      end
+      # verify the required parameter 'x_credential_type' is set
+      if @api_client.config.client_side_validation && x_credential_type.nil?
+        fail ArgumentError, "Missing the required parameter 'x_credential_type' when calling ApiProcessRouteApi.delete_v1_process_route_delete"
+      end
+      # verify enum value
+      allowable_values = ["Token", "API Key"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(x_credential_type)
+        fail ArgumentError, "invalid value for \"x_credential_type\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/processRoute/Delete'
+
+      # 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
+      header_params[:'X-Credential-Type'] = x_credential_type
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'api_catalog_delete_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PutV1DeliveryReturnReceipt200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey', 'Signature', 'BearerToken', 'Timestamp']
+
+      new_options = opts.merge(
+        :operation => :"ApiProcessRouteApi.delete_v1_process_route_delete",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApiProcessRouteApi#delete_v1_process_route_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 按路线编码或查询返回的 ID 精确查询，两者同时传入须一致。
+    # 
+    # @param x_credential_type [String] Use &#39;Token&#39; with bearer authorization, or &#39;API Key&#39; with signed API key headers. This header is mandatory in the deployed API.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :code 业务编码；code / id 至少一项，同时提供须匹配同一记录。
+    # @option opts [String] :id 本模块查询返回的 ID；可用 code 替代。
+    # @return [PostV1ProcessRouteCreate200Response]
+    def get_v1_process_route_get(x_credential_type, opts = {})
+      data, _status_code, _headers = get_v1_process_route_get_with_http_info(x_credential_type, opts)
+      data
+    end
+
+    # 按路线编码或查询返回的 ID 精确查询，两者同时传入须一致。
+    # 
+    # @param x_credential_type [String] Use &#39;Token&#39; with bearer authorization, or &#39;API Key&#39; with signed API key headers. This header is mandatory in the deployed API.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :code 业务编码；code / id 至少一项，同时提供须匹配同一记录。
+    # @option opts [String] :id 本模块查询返回的 ID；可用 code 替代。
+    # @return [Array<(PostV1ProcessRouteCreate200Response, Integer, Hash)>] PostV1ProcessRouteCreate200Response data, response status code and response headers
+    def get_v1_process_route_get_with_http_info(x_credential_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiProcessRouteApi.get_v1_process_route_get ...'
+      end
+      # verify the required parameter 'x_credential_type' is set
+      if @api_client.config.client_side_validation && x_credential_type.nil?
+        fail ArgumentError, "Missing the required parameter 'x_credential_type' when calling ApiProcessRouteApi.get_v1_process_route_get"
+      end
+      # verify enum value
+      allowable_values = ["Token", "API Key"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(x_credential_type)
+        fail ArgumentError, "invalid value for \"x_credential_type\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/processRoute/Get'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil?
+      query_params[:'id'] = opts[:'id'] if !opts[:'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']
+      header_params[:'X-Credential-Type'] = x_credential_type
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PostV1ProcessRouteCreate200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey', 'Signature', 'BearerToken', 'Timestamp']
+
+      new_options = opts.merge(
+        :operation => :"ApiProcessRouteApi.get_v1_process_route_get",
+        :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: ApiProcessRouteApi#get_v1_process_route_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 分页查询正常路线；searchText 匹配编码或名称，scopeCode 筛选加工阶段。
+    # 
+    # @param x_credential_type [String] Use &#39;Token&#39; with bearer authorization, or &#39;API Key&#39; with signed API key headers. This header is mandatory in the deployed API.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :search_text 按编码或名称进行包含搜索。
+    # @option opts [String] :scope_code 加工阶段编码，来自 Scope 枚举。
+    # @option opts [Integer] :page 页码默认 1；小于等于 0 时使用 1。 (default to 1)
+    # @option opts [Integer] :page_size 每页条数默认 10；允许 1～100，超出时使用 10。 (default to 10)
+    # @return [GetV1ProcessRouteListPaging200Response]
+    def get_v1_process_route_list_paging(x_credential_type, opts = {})
+      data, _status_code, _headers = get_v1_process_route_list_paging_with_http_info(x_credential_type, opts)
+      data
+    end
+
+    # 分页查询正常路线；searchText 匹配编码或名称，scopeCode 筛选加工阶段。
+    # 
+    # @param x_credential_type [String] Use &#39;Token&#39; with bearer authorization, or &#39;API Key&#39; with signed API key headers. This header is mandatory in the deployed API.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :search_text 按编码或名称进行包含搜索。
+    # @option opts [String] :scope_code 加工阶段编码，来自 Scope 枚举。
+    # @option opts [Integer] :page 页码默认 1；小于等于 0 时使用 1。 (default to 1)
+    # @option opts [Integer] :page_size 每页条数默认 10；允许 1～100，超出时使用 10。 (default to 10)
+    # @return [Array<(GetV1ProcessRouteListPaging200Response, Integer, Hash)>] GetV1ProcessRouteListPaging200Response data, response status code and response headers
+    def get_v1_process_route_list_paging_with_http_info(x_credential_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiProcessRouteApi.get_v1_process_route_list_paging ...'
+      end
+      # verify the required parameter 'x_credential_type' is set
+      if @api_client.config.client_side_validation && x_credential_type.nil?
+        fail ArgumentError, "Missing the required parameter 'x_credential_type' when calling ApiProcessRouteApi.get_v1_process_route_list_paging"
+      end
+      # verify enum value
+      allowable_values = ["Token", "API Key"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(x_credential_type)
+        fail ArgumentError, "invalid value for \"x_credential_type\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/processRoute/ListPaging'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'searchText'] = opts[:'search_text'] if !opts[:'search_text'].nil?
+      query_params[:'scopeCode'] = opts[:'scope_code'] if !opts[:'scope_code'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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']
+      header_params[:'X-Credential-Type'] = x_credential_type
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetV1ProcessRouteListPaging200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey', 'Signature', 'BearerToken', 'Timestamp']
+
+      new_options = opts.merge(
+        :operation => :"ApiProcessRouteApi.get_v1_process_route_list_paging",
+        :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: ApiProcessRouteApi#get_v1_process_route_list_paging\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 创建加工路线及有序工序。
+    # 
+    # @param x_credential_type [String] Use &#39;Token&#39; with bearer authorization, or &#39;API Key&#39; with signed API key headers. This header is mandatory in the deployed API.
+    # @param api_process_route_create_request [ApiProcessRouteCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PostV1ProcessRouteCreate200Response]
+    def post_v1_process_route_create(x_credential_type, api_process_route_create_request, opts = {})
+      data, _status_code, _headers = post_v1_process_route_create_with_http_info(x_credential_type, api_process_route_create_request, opts)
+      data
+    end
+
+    # 创建加工路线及有序工序。
+    # 
+    # @param x_credential_type [String] Use &#39;Token&#39; with bearer authorization, or &#39;API Key&#39; with signed API key headers. This header is mandatory in the deployed API.
+    # @param api_process_route_create_request [ApiProcessRouteCreateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PostV1ProcessRouteCreate200Response, Integer, Hash)>] PostV1ProcessRouteCreate200Response data, response status code and response headers
+    def post_v1_process_route_create_with_http_info(x_credential_type, api_process_route_create_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiProcessRouteApi.post_v1_process_route_create ...'
+      end
+      # verify the required parameter 'x_credential_type' is set
+      if @api_client.config.client_side_validation && x_credential_type.nil?
+        fail ArgumentError, "Missing the required parameter 'x_credential_type' when calling ApiProcessRouteApi.post_v1_process_route_create"
+      end
+      # verify enum value
+      allowable_values = ["Token", "API Key"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(x_credential_type)
+        fail ArgumentError, "invalid value for \"x_credential_type\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'api_process_route_create_request' is set
+      if @api_client.config.client_side_validation && api_process_route_create_request.nil?
+        fail ArgumentError, "Missing the required parameter 'api_process_route_create_request' when calling ApiProcessRouteApi.post_v1_process_route_create"
+      end
+      # resource path
+      local_var_path = '/v1/processRoute/Create'
+
+      # 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
+      header_params[:'X-Credential-Type'] = x_credential_type
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(api_process_route_create_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PostV1ProcessRouteCreate200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey', 'Signature', 'BearerToken', 'Timestamp']
+
+      new_options = opts.merge(
+        :operation => :"ApiProcessRouteApi.post_v1_process_route_create",
+        :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: ApiProcessRouteApi#post_v1_process_route_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 完整修改路线；steps 省略保留原工序，数组则替换全部工序，空数组清空。
+    # 
+    # @param x_credential_type [String] Use &#39;Token&#39; with bearer authorization, or &#39;API Key&#39; with signed API key headers. This header is mandatory in the deployed API.
+    # @param api_process_route_update_request [ApiProcessRouteUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PostV1ProcessRouteCreate200Response]
+    def put_v1_process_route_update(x_credential_type, api_process_route_update_request, opts = {})
+      data, _status_code, _headers = put_v1_process_route_update_with_http_info(x_credential_type, api_process_route_update_request, opts)
+      data
+    end
+
+    # 完整修改路线；steps 省略保留原工序，数组则替换全部工序，空数组清空。
+    # 
+    # @param x_credential_type [String] Use &#39;Token&#39; with bearer authorization, or &#39;API Key&#39; with signed API key headers. This header is mandatory in the deployed API.
+    # @param api_process_route_update_request [ApiProcessRouteUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PostV1ProcessRouteCreate200Response, Integer, Hash)>] PostV1ProcessRouteCreate200Response data, response status code and response headers
+    def put_v1_process_route_update_with_http_info(x_credential_type, api_process_route_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiProcessRouteApi.put_v1_process_route_update ...'
+      end
+      # verify the required parameter 'x_credential_type' is set
+      if @api_client.config.client_side_validation && x_credential_type.nil?
+        fail ArgumentError, "Missing the required parameter 'x_credential_type' when calling ApiProcessRouteApi.put_v1_process_route_update"
+      end
+      # verify enum value
+      allowable_values = ["Token", "API Key"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(x_credential_type)
+        fail ArgumentError, "invalid value for \"x_credential_type\", must be one of #{allowable_values}"
+      end
+      # verify the required parameter 'api_process_route_update_request' is set
+      if @api_client.config.client_side_validation && api_process_route_update_request.nil?
+        fail ArgumentError, "Missing the required parameter 'api_process_route_update_request' when calling ApiProcessRouteApi.put_v1_process_route_update"
+      end
+      # resource path
+      local_var_path = '/v1/processRoute/Update'
+
+      # 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
+      header_params[:'X-Credential-Type'] = x_credential_type
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(api_process_route_update_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PostV1ProcessRouteCreate200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey', 'Signature', 'BearerToken', 'Timestamp']
+
+      new_options = opts.merge(
+        :operation => :"ApiProcessRouteApi.put_v1_process_route_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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ApiProcessRouteApi#put_v1_process_route_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end