tachain-sdk 0.1.0

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

@@ -0,0 +1,396 @@
+=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 ApiDeclarationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 申报信息删除接口。
+    # 删除只会软删除申报资料记录，不会删除订单、生产单、发货单，也不会触发快速申报。 删除后会按受影响的 `StageId + ExtendId` 重新计算申报完成度。
+    # @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 [String] :attachment_id query 方式传入的单个附件申报 ID。
+    # @option opts [String] :form_data_id query 方式传入的单个表单申报 ID。
+    # @option opts [ApiDeclarationDeleteRequest] :api_declaration_delete_request 
+    # @return [Model4]
+    def delete_v1_declaration_delete(x_credential_type, opts = {})
+      data, _status_code, _headers = delete_v1_declaration_delete_with_http_info(x_credential_type, opts)
+      data
+    end
+
+    # 申报信息删除接口。
+    # 删除只会软删除申报资料记录，不会删除订单、生产单、发货单，也不会触发快速申报。 删除后会按受影响的 `StageId + ExtendId` 重新计算申报完成度。
+    # @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 [String] :attachment_id query 方式传入的单个附件申报 ID。
+    # @option opts [String] :form_data_id query 方式传入的单个表单申报 ID。
+    # @option opts [ApiDeclarationDeleteRequest] :api_declaration_delete_request 
+    # @return [Array<(Model4, Integer, Hash)>] Model4 data, response status code and response headers
+    def delete_v1_declaration_delete_with_http_info(x_credential_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiDeclarationApi.delete_v1_declaration_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 ApiDeclarationApi.delete_v1_declaration_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/declaration/Delete'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'attachmentId'] = opts[:'attachment_id'] if !opts[:'attachment_id'].nil?
+      query_params[:'formDataId'] = opts[:'form_data_id'] if !opts[:'form_data_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']
+      # 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_declaration_delete_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Model4'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey', 'Signature', 'BearerToken', 'Timestamp']
+
+      new_options = opts.merge(
+        :operation => :"ApiDeclarationApi.delete_v1_declaration_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: ApiDeclarationApi#delete_v1_declaration_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 申报信息查询接口。
+    # 附件申报和表单申报分别分页查询后放在同一个响应中返回。 建议调用方尽量传入 `extendId` 和 `stageId`，以便精确查询某个业务单据的申报资料。
+    # @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 关键词搜索：支持阶段编码，如 Order、Production（StageId）。使用完整关键词进行包含匹配，任一字段命中即可，并与其他筛选条件共同生效；不传、空字符串或纯空白时不附加关键词条件。
+    # @option opts [Array<String>] :extend_id 
+    # @option opts [Array<String>] :stage_id 
+    # @option opts [Array<String>] :document_type_id 
+    # @option opts [String] :document_type_code 
+    # @option opts [String] :extend_number 
+    # @option opts [Time] :extend_date 
+    # @option opts [String] :extend_line_number 
+    # @option opts [String] :order_side 
+    # @option opts [String] :product_code 
+    # @option opts [Integer] :production_type 
+    # @option opts [String] :delivery_number 
+    # @option opts [Integer] :status 
+    # @option opts [Array<Integer>] :risk_warning 
+    # @option opts [String] :sort_by 
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :page_size  (default to 10)
+    # @return [ApiResponseApiDeclarationListDto]
+    def get_v1_declaration_list_paging(x_credential_type, opts = {})
+      data, _status_code, _headers = get_v1_declaration_list_paging_with_http_info(x_credential_type, opts)
+      data
+    end
+
+    # 申报信息查询接口。
+    # 附件申报和表单申报分别分页查询后放在同一个响应中返回。 建议调用方尽量传入 &#x60;extendId&#x60; 和 &#x60;stageId&#x60;，以便精确查询某个业务单据的申报资料。
+    # @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 关键词搜索：支持阶段编码，如 Order、Production（StageId）。使用完整关键词进行包含匹配，任一字段命中即可，并与其他筛选条件共同生效；不传、空字符串或纯空白时不附加关键词条件。
+    # @option opts [Array<String>] :extend_id 
+    # @option opts [Array<String>] :stage_id 
+    # @option opts [Array<String>] :document_type_id 
+    # @option opts [String] :document_type_code 
+    # @option opts [String] :extend_number 
+    # @option opts [Time] :extend_date 
+    # @option opts [String] :extend_line_number 
+    # @option opts [String] :order_side 
+    # @option opts [String] :product_code 
+    # @option opts [Integer] :production_type 
+    # @option opts [String] :delivery_number 
+    # @option opts [Integer] :status 
+    # @option opts [Array<Integer>] :risk_warning 
+    # @option opts [String] :sort_by 
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :page_size  (default to 10)
+    # @return [Array<(ApiResponseApiDeclarationListDto, Integer, Hash)>] ApiResponseApiDeclarationListDto data, response status code and response headers
+    def get_v1_declaration_list_paging_with_http_info(x_credential_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiDeclarationApi.get_v1_declaration_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 ApiDeclarationApi.get_v1_declaration_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/declaration/ListPaging'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'searchText'] = opts[:'search_text'] if !opts[:'search_text'].nil?
+      query_params[:'extendId'] = @api_client.build_collection_param(opts[:'extend_id'], :multi) if !opts[:'extend_id'].nil?
+      query_params[:'stageId'] = @api_client.build_collection_param(opts[:'stage_id'], :multi) if !opts[:'stage_id'].nil?
+      query_params[:'documentTypeId'] = @api_client.build_collection_param(opts[:'document_type_id'], :multi) if !opts[:'document_type_id'].nil?
+      query_params[:'documentTypeCode'] = opts[:'document_type_code'] if !opts[:'document_type_code'].nil?
+      query_params[:'extendNumber'] = opts[:'extend_number'] if !opts[:'extend_number'].nil?
+      query_params[:'extendDate'] = opts[:'extend_date'] if !opts[:'extend_date'].nil?
+      query_params[:'extendLineNumber'] = opts[:'extend_line_number'] if !opts[:'extend_line_number'].nil?
+      query_params[:'orderSide'] = opts[:'order_side'] if !opts[:'order_side'].nil?
+      query_params[:'productCode'] = opts[:'product_code'] if !opts[:'product_code'].nil?
+      query_params[:'productionType'] = opts[:'production_type'] if !opts[:'production_type'].nil?
+      query_params[:'deliveryNumber'] = opts[:'delivery_number'] if !opts[:'delivery_number'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'riskWarning'] = @api_client.build_collection_param(opts[:'risk_warning'], :multi) if !opts[:'risk_warning'].nil?
+      query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].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] || 'ApiResponseApiDeclarationListDto'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey', 'Signature', 'BearerToken', 'Timestamp']
+
+      new_options = opts.merge(
+        :operation => :"ApiDeclarationApi.get_v1_declaration_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: ApiDeclarationApi#get_v1_declaration_list_paging\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 单据所需申报信息查询接口。
+    # 该接口只接收能够唯一定位已存在单据的字段。订单、生产、发货等链路参数由接口内部从系统数据反查， 不再要求外部传供应商、客户、产品、国家、订单行、领料明细等规则参数。 调用方应先调用本接口取得 `DocumentTypeId`、是否必填、表单结构等信息，再调用提交接口保存附件或表单数据。
+    # @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] :stage_code 申报阶段编码，例如 &#x60;Order&#x60;、&#x60;Production&#x60;、&#x60;Receipt&#x60;、&#x60;Deliverynote&#x60;。
+    # @option opts [String] :id 阶段业务单据内部 ID，例如订单 ID、生产单 ID、发货单 ID。
+    # @option opts [String] :order_number 订单号；订单阶段未传 id 时，配合 orderDate 定位订单。
+    # @option opts [Time] :order_date 订单日期；订单阶段按订单号定位时必传。
+    # @option opts [String] :order_side 订单侧别，常用 &#x60;PO&#x60; 或 &#x60;SO&#x60;；订单号和日期不唯一时用于区分。
+    # @option opts [String] :production_number 生产单号；生产/入库阶段未传 id 时，配合产品编码和类型定位生产单。
+    # @option opts [String] :product_code 产品编码；生产/入库阶段按生产单号定位时参与唯一性判断。
+    # @option opts [Integer] :production_type 生产类型；生产阶段默认 0，入库阶段默认 1。
+    # @option opts [String] :delivery_number 发货单号；发货阶段未传 id 时用于定位发货单。
+    # @return [Model3]
+    def get_v1_declaration_required_documents(x_credential_type, opts = {})
+      data, _status_code, _headers = get_v1_declaration_required_documents_with_http_info(x_credential_type, opts)
+      data
+    end
+
+    # 单据所需申报信息查询接口。
+    # 该接口只接收能够唯一定位已存在单据的字段。订单、生产、发货等链路参数由接口内部从系统数据反查， 不再要求外部传供应商、客户、产品、国家、订单行、领料明细等规则参数。 调用方应先调用本接口取得 &#x60;DocumentTypeId&#x60;、是否必填、表单结构等信息，再调用提交接口保存附件或表单数据。
+    # @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] :stage_code 申报阶段编码，例如 &#x60;Order&#x60;、&#x60;Production&#x60;、&#x60;Receipt&#x60;、&#x60;Deliverynote&#x60;。
+    # @option opts [String] :id 阶段业务单据内部 ID，例如订单 ID、生产单 ID、发货单 ID。
+    # @option opts [String] :order_number 订单号；订单阶段未传 id 时，配合 orderDate 定位订单。
+    # @option opts [Time] :order_date 订单日期；订单阶段按订单号定位时必传。
+    # @option opts [String] :order_side 订单侧别，常用 &#x60;PO&#x60; 或 &#x60;SO&#x60;；订单号和日期不唯一时用于区分。
+    # @option opts [String] :production_number 生产单号；生产/入库阶段未传 id 时，配合产品编码和类型定位生产单。
+    # @option opts [String] :product_code 产品编码；生产/入库阶段按生产单号定位时参与唯一性判断。
+    # @option opts [Integer] :production_type 生产类型；生产阶段默认 0，入库阶段默认 1。
+    # @option opts [String] :delivery_number 发货单号；发货阶段未传 id 时用于定位发货单。
+    # @return [Array<(Model3, Integer, Hash)>] Model3 data, response status code and response headers
+    def get_v1_declaration_required_documents_with_http_info(x_credential_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiDeclarationApi.get_v1_declaration_required_documents ...'
+      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 ApiDeclarationApi.get_v1_declaration_required_documents"
+      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/declaration/RequiredDocuments'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'stageCode'] = opts[:'stage_code'] if !opts[:'stage_code'].nil?
+      query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
+      query_params[:'orderNumber'] = opts[:'order_number'] if !opts[:'order_number'].nil?
+      query_params[:'orderDate'] = opts[:'order_date'] if !opts[:'order_date'].nil?
+      query_params[:'orderSide'] = opts[:'order_side'] if !opts[:'order_side'].nil?
+      query_params[:'productionNumber'] = opts[:'production_number'] if !opts[:'production_number'].nil?
+      query_params[:'productCode'] = opts[:'product_code'] if !opts[:'product_code'].nil?
+      query_params[:'productionType'] = opts[:'production_type'] if !opts[:'production_type'].nil?
+      query_params[:'deliveryNumber'] = opts[:'delivery_number'] if !opts[:'delivery_number'].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] || 'Model3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey', 'Signature', 'BearerToken', 'Timestamp']
+
+      new_options = opts.merge(
+        :operation => :"ApiDeclarationApi.get_v1_declaration_required_documents",
+        :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: ApiDeclarationApi#get_v1_declaration_required_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 申报文件/表单提交接口。
+    #  入参结构与内部 `BatchCreateStageAttachment` 保持一致：             `ExtendId` 表示订单/生产单/发货单等业务 ID，`StageId` 表示申报阶段，             `DocumentList` 中每个元素表示一种申报资料类型。  每个 `DocumentList` 元素可以同时包含 `FileList` 和 `FormDataList`。             文件资料和表单资料会分别进入各自服务保存，随后统一重算申报完成度。
+    # @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 [ApiDeclarationSubmitRequest] :api_declaration_submit_request 
+    # @return [ApiResponseApiDeclarationSubmitResultDto]
+    def post_v1_declaration_submit(x_credential_type, opts = {})
+      data, _status_code, _headers = post_v1_declaration_submit_with_http_info(x_credential_type, opts)
+      data
+    end
+
+    # 申报文件/表单提交接口。
+    #  入参结构与内部 &#x60;BatchCreateStageAttachment&#x60; 保持一致：             &#x60;ExtendId&#x60; 表示订单/生产单/发货单等业务 ID，&#x60;StageId&#x60; 表示申报阶段，             &#x60;DocumentList&#x60; 中每个元素表示一种申报资料类型。  每个 &#x60;DocumentList&#x60; 元素可以同时包含 &#x60;FileList&#x60; 和 &#x60;FormDataList&#x60;。             文件资料和表单资料会分别进入各自服务保存，随后统一重算申报完成度。
+    # @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 [ApiDeclarationSubmitRequest] :api_declaration_submit_request 
+    # @return [Array<(ApiResponseApiDeclarationSubmitResultDto, Integer, Hash)>] ApiResponseApiDeclarationSubmitResultDto data, response status code and response headers
+    def post_v1_declaration_submit_with_http_info(x_credential_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiDeclarationApi.post_v1_declaration_submit ...'
+      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 ApiDeclarationApi.post_v1_declaration_submit"
+      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/declaration/Submit'
+
+      # 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_declaration_submit_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiResponseApiDeclarationSubmitResultDto'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey', 'Signature', 'BearerToken', 'Timestamp']
+
+      new_options = opts.merge(
+        :operation => :"ApiDeclarationApi.post_v1_declaration_submit",
+        :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: ApiDeclarationApi#post_v1_declaration_submit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end