tachain-sdk 0.1.0 → 0.1.1

data/lib/tachain-sdk/models/{document_type_api_dto.rb → api_document_type_response.rb}

@@ -14,79 +14,72 @@ require 'date'
 require 'time'
 
 module TachainSdk
-  # Table, document_type
-  class DocumentTypeApiDto < ApiModelBase
-    # 文档类型ID
+  # 集成接口专用 ApiDocumentTypeResponse；只读业务返回字段，不参与写入模型。
+  class ApiDocumentTypeResponse < ApiModelBase
+    # 申报资料类型 ID，标识“需要提交哪一种资料”，不是订单 ID、上传文件 ID 或已提交申报记录 ID。
     attr_accessor :id
 
-    # 文档code
+    # 申报资料类型代码，例如 Purchase_order；选中该项后原样填写 Submit 的 documentList[].documentTypeCode。
     attr_accessor :code
 
-    # 文档名称
+    # 资料类型原始名称，用于展示；不能代替 documentTypeCode。
     attr_accessor :name
 
-    # 文档类别（From/Attachment/Both）
+    # 资料提交形式：Attachment 附件；From 表单（实际返回拼写为 From）；Both 支持附件和表单。
     attr_accessor :type
 
-    # 允许的文件格式（仅附件类型需要）
+    # 该申报项允许的附件扩展名，例如 pdf,jpg,png；上传前按此选择文件。
     attr_accessor :allowed_format
 
-    # 表单结构定义（仅表单类型需要）json
+    # 表单字段定义的 JSON 字符串。解析为数组后保留字段定义并填写 value，再序列化为字符串提交到 formDataList[].formData；可能为空或字符串 null。
     attr_accessor :schema_definition
 
     # 备注
     attr_accessor :remark
 
-    # -9 禁用, -1 删除, 0 正常
+    # 记录状态：0 正常，-1 已删除，-9 禁用。
     attr_accessor :status
 
-    # 创建用户ID
-    attr_accessor :created_by
-
-    # 修改用户ID
-    attr_accessor :updated_by
-
     # 创建时间
     attr_accessor :created_at
 
     # 更新时间
     attr_accessor :updated_at
 
-    # 文件数量限制
+    # 该申报项配置的文件数量上限；为空时未返回限制值。
     attr_accessor :file_quantity_limit
 
-    # 模板示例
+    # 该资料类型的示例模板引用；为空时未提供模板。
     attr_accessor :example_template
 
-    # 模板名称，带后缀
+    # 示例模板文件名，包含扩展名。
     attr_accessor :example_name
 
-    # 是否启动ai审核功能
-    attr_accessor :is_start_ai
-
-    # 是否必填
+    # 是否必填：1 必填，0 非必填；为空时未返回要求。
     attr_accessor :is_required
 
-    # 完成情况
+    # 申报完成情况的字符串表示；可能为空，空值不代表已完成。提交后重新查询，并结合审核前校验判断。
     attr_accessor :iscomplete
 
-    # 数据来源，0 买卖双方都可以，1 卖方优先，2 买方优先，3 仅卖方，4 仅买方
+    # 资料提供方：0 买卖双方均可；1 卖方优先；2 买方优先；3 仅卖方；4 仅买方。
     attr_accessor :from
 
+    # 该资料类型下已经提交的附件信息；不是本次尚未绑定的上传文件列表。
     attr_accessor :file_list
 
+    # 该资料类型下已经保存的表单记录。
     attr_accessor :form_data_list
 
-    # 翻译后的名称
+    # 按请求语言返回的资料名称，展示时优先使用；为空时使用 name。
     attr_accessor :local_name
 
-    # 翻译后的备注
+    # 按请求语言返回的备注。
     attr_accessor :local_remark
 
-    # 去除 po_ 前缀后的采购加工阶段编码。
+    # 该申报项适用的加工阶段编码。
     attr_accessor :scope_code
 
-    # 申报规则配置的纤维编码，支持逗号分隔多个 ID。
+    # 申报规则涉及的纤维标识，多个值以逗号分隔；用于展示规则范围。
     attr_accessor :fiber_code
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -100,14 +93,11 @@ module TachainSdk
         :'schema_definition' => :'schemaDefinition',
         :'remark' => :'remark',
         :'status' => :'status',
-        :'created_by' => :'createdBy',
-        :'updated_by' => :'updatedBy',
         :'created_at' => :'createdAt',
         :'updated_at' => :'updatedAt',
         :'file_quantity_limit' => :'fileQuantityLimit',
         :'example_template' => :'exampleTemplate',
         :'example_name' => :'exampleName',
-        :'is_start_ai' => :'isStartAi',
         :'is_required' => :'isRequired',
         :'iscomplete' => :'iscomplete',
         :'from' => :'from',
@@ -141,19 +131,16 @@ module TachainSdk
         :'schema_definition' => :'String',
         :'remark' => :'String',
         :'status' => :'Integer',
-        :'created_by' => :'String',
-        :'updated_by' => :'String',
         :'created_at' => :'Time',
         :'updated_at' => :'Time',
         :'file_quantity_limit' => :'Integer',
         :'example_template' => :'String',
         :'example_name' => :'String',
-        :'is_start_ai' => :'Boolean',
         :'is_required' => :'Integer',
         :'iscomplete' => :'String',
         :'from' => :'Integer',
-        :'file_list' => :'Array<AttachmentInApiDto>',
-        :'form_data_list' => :'Array<OrderStageFormApiDto>',
+        :'file_list' => :'Array<ApiFileResponse>',
+        :'form_data_list' => :'Array<ApiDocumentFormResponse>',
         :'local_name' => :'String',
         :'local_remark' => :'String',
         :'scope_code' => :'String',
@@ -172,15 +159,16 @@ module TachainSdk
         :'schema_definition',
         :'remark',
         :'status',
-        :'created_by',
-        :'updated_by',
         :'created_at',
         :'updated_at',
         :'file_quantity_limit',
         :'example_template',
         :'example_name',
-        :'is_start_ai',
+        :'is_required',
         :'iscomplete',
+        :'from',
+        :'file_list',
+        :'form_data_list',
         :'local_name',
         :'local_remark',
         :'scope_code',
@@ -192,14 +180,14 @@ module TachainSdk
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `TachainSdk::DocumentTypeApiDto` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TachainSdk::ApiDocumentTypeResponse` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `TachainSdk::DocumentTypeApiDto`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TachainSdk::ApiDocumentTypeResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -236,14 +224,6 @@ module TachainSdk
         self.status = attributes[:'status']
       end
 
-      if attributes.key?(:'created_by')
-        self.created_by = attributes[:'created_by']
-      end
-
-      if attributes.key?(:'updated_by')
-        self.updated_by = attributes[:'updated_by']
-      end
-
       if attributes.key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
@@ -264,14 +244,8 @@ module TachainSdk
         self.example_name = attributes[:'example_name']
       end
 
-      if attributes.key?(:'is_start_ai')
-        self.is_start_ai = attributes[:'is_start_ai']
-      end
-
       if attributes.key?(:'is_required')
         self.is_required = attributes[:'is_required']
-      else
-        self.is_required = nil
       end
 
       if attributes.key?(:'iscomplete')
@@ -280,24 +254,18 @@ module TachainSdk
 
       if attributes.key?(:'from')
         self.from = attributes[:'from']
-      else
-        self.from = nil
       end
 
       if attributes.key?(:'file_list')
         if (value = attributes[:'file_list']).is_a?(Array)
           self.file_list = value
         end
-      else
-        self.file_list = nil
       end
 
       if attributes.key?(:'form_data_list')
         if (value = attributes[:'form_data_list']).is_a?(Array)
           self.form_data_list = value
         end
-      else
-        self.form_data_list = nil
       end
 
       if attributes.key?(:'local_name')
@@ -322,22 +290,6 @@ module TachainSdk
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @is_required.nil?
-        invalid_properties.push('invalid value for "is_required", is_required cannot be nil.')
-      end
-
-      if @from.nil?
-        invalid_properties.push('invalid value for "from", from cannot be nil.')
-      end
-
-      if @file_list.nil?
-        invalid_properties.push('invalid value for "file_list", file_list cannot be nil.')
-      end
-
-      if @form_data_list.nil?
-        invalid_properties.push('invalid value for "form_data_list", form_data_list cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -345,53 +297,9 @@ module TachainSdk
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @is_required.nil?
-      return false if @from.nil?
-      return false if @file_list.nil?
-      return false if @form_data_list.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] is_required Value to be assigned
-    def is_required=(is_required)
-      if is_required.nil?
-        fail ArgumentError, 'is_required cannot be nil'
-      end
-
-      @is_required = is_required
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] from Value to be assigned
-    def from=(from)
-      if from.nil?
-        fail ArgumentError, 'from cannot be nil'
-      end
-
-      @from = from
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] file_list Value to be assigned
-    def file_list=(file_list)
-      if file_list.nil?
-        fail ArgumentError, 'file_list cannot be nil'
-      end
-
-      @file_list = file_list
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] form_data_list Value to be assigned
-    def form_data_list=(form_data_list)
-      if form_data_list.nil?
-        fail ArgumentError, 'form_data_list cannot be nil'
-      end
-
-      @form_data_list = form_data_list
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -405,14 +313,11 @@ module TachainSdk
           schema_definition == o.schema_definition &&
           remark == o.remark &&
           status == o.status &&
-          created_by == o.created_by &&
-          updated_by == o.updated_by &&
           created_at == o.created_at &&
           updated_at == o.updated_at &&
           file_quantity_limit == o.file_quantity_limit &&
           example_template == o.example_template &&
           example_name == o.example_name &&
-          is_start_ai == o.is_start_ai &&
           is_required == o.is_required &&
           iscomplete == o.iscomplete &&
           from == o.from &&
@@ -433,7 +338,7 @@ module TachainSdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, code, name, type, allowed_format, schema_definition, remark, status, created_by, updated_by, created_at, updated_at, file_quantity_limit, example_template, example_name, is_start_ai, is_required, iscomplete, from, file_list, form_data_list, local_name, local_remark, scope_code, fiber_code].hash
+      [id, code, name, type, allowed_format, schema_definition, remark, status, created_at, updated_at, file_quantity_limit, example_template, example_name, is_required, iscomplete, from, file_list, form_data_list, local_name, local_remark, scope_code, fiber_code].hash
     end
 
     # Builds the object from hash

data/lib/tachain-sdk/models/api_enum_value_response.rb

@@ -0,0 +1,193 @@
+=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 'date'
+require 'time'
+
+module TachainSdk
+  # 当前身份可见的枚举值。
+  class ApiEnumValueResponse < ApiModelBase
+    # 查询返回的记录 ID。
+    attr_accessor :id
+
+    # 枚举业务类型代码。
+    attr_accessor :enum_type_id
+
+    # 可用于接口输入的枚举业务值。
+    attr_accessor :value
+
+    # 名称。
+    attr_accessor :name
+
+    # 当地语言名称。
+    attr_accessor :native_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'enum_type_id' => :'enumTypeId',
+        :'value' => :'value',
+        :'name' => :'name',
+        :'native_name' => :'nativeName'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'Integer',
+        :'enum_type_id' => :'String',
+        :'value' => :'String',
+        :'name' => :'String',
+        :'native_name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'enum_type_id',
+        :'value',
+        :'name',
+        :'native_name'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TachainSdk::ApiEnumValueResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TachainSdk::ApiEnumValueResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'enum_type_id')
+        self.enum_type_id = attributes[:'enum_type_id']
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'native_name')
+        self.native_name = attributes[:'native_name']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          enum_type_id == o.enum_type_id &&
+          value == o.value &&
+          name == o.name &&
+          native_name == o.native_name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, enum_type_id, value, name, native_name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/tachain-sdk/models/{api_response_string.rb → api_error_response.rb}

@@ -14,19 +14,23 @@ require 'date'
 require 'time'
 
 module TachainSdk
-  class ApiResponseString < ApiModelBase
+  # 集成错误响应；Data 为业务错误详情，可能是文本、数组或校验结果。
+  class ApiErrorResponse < ApiModelBase
+    # 业务状态码。
     attr_accessor :code
 
-    attr_accessor :message
-
+    # 业务返回数据。
     attr_accessor :data
 
+    # 按请求语言返回的提示，未指定语言时默认中文。
+    attr_accessor :message
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'code' => :'code',
-        :'message' => :'message',
-        :'data' => :'data'
+        :'data' => :'data',
+        :'message' => :'message'
       }
     end
 
@@ -44,15 +48,16 @@ module TachainSdk
     def self.openapi_types
       {
         :'code' => :'Integer',
-        :'message' => :'String',
-        :'data' => :'String'
+        :'data' => :'Object',
+        :'message' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'data'
+        :'data',
+        :'message'
       ])
     end
 
@@ -60,14 +65,14 @@ module TachainSdk
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `TachainSdk::ApiResponseString` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TachainSdk::ApiErrorResponse` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `TachainSdk::ApiResponseString`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TachainSdk::ApiErrorResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -78,15 +83,13 @@ module TachainSdk
         self.code = nil
       end
 
-      if attributes.key?(:'message')
-        self.message = attributes[:'message']
-      else
-        self.message = nil
-      end
-
       if attributes.key?(:'data')
         self.data = attributes[:'data']
       end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -98,10 +101,6 @@ module TachainSdk
         invalid_properties.push('invalid value for "code", code cannot be nil.')
       end
 
-      if @message.nil?
-        invalid_properties.push('invalid value for "message", message cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -110,7 +109,6 @@ module TachainSdk
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @code.nil?
-      return false if @message.nil?
       true
     end
 
@@ -124,24 +122,14 @@ module TachainSdk
       @code = code
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] message Value to be assigned
-    def message=(message)
-      if message.nil?
-        fail ArgumentError, 'message cannot be nil'
-      end
-
-      @message = message
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           code == o.code &&
-          message == o.message &&
-          data == o.data
+          data == o.data &&
+          message == o.message
     end
 
     # @see the `==` method
@@ -153,7 +141,7 @@ module TachainSdk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [code, message, data].hash
+      [code, data, message].hash
     end
 
     # Builds the object from hash