tachain-sdk 0.1.0

data/lib/tachain-sdk/configuration.rb

@@ -0,0 +1,329 @@
+=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
+
+module TachainSdk
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Define server configuration index
+    attr_accessor :server_index
+
+    # Define server operation configuration index
+    attr_accessor :server_operation_index
+
+    # Default server variables
+    attr_accessor :server_variables
+
+    # Default server operation variables
+    attr_accessor :server_operation_variables
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
+    # Overrides the access_token if set
+    # @return [Proc]
+    attr_accessor :access_token_getter
+
+    # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
+    # HTTP responses with return type `File` will be returned as a stream of binary data.
+    # Default to false.
+    attr_accessor :return_binary_data
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Set this to ignore operation servers for the API client. This is useful when you need to
+    # send requests to a different server than the one specified in the OpenAPI document.
+    # Will default to the base url defined in the spec but can be overridden by setting
+    # `scheme`, `host`, `base_path` directly.
+    # Default to false.
+    # @return [true, false]
+    attr_accessor :ignore_operation_servers
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # The time limit for HTTP request in seconds.
+    # Default to 0 (never times out).
+    attr_accessor :timeout
+
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    def initialize
+      @scheme = 'https'
+      @host = 'api.example.com'
+      @base_path = ''
+      @server_index = nil
+      @server_operation_index = {}
+      @server_variables = {}
+      @server_operation_variables = {}
+      @api_key = {}
+      @api_key_prefix = {}
+      @client_side_validation = true
+      @verify_ssl = true
+      @verify_ssl_host = true
+      @cert_file = nil
+      @key_file = nil
+      @timeout = 0
+      @params_encoding = nil
+      @debugging = false
+      @ignore_operation_servers = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+
+      yield(self) if block_given?
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = '' if @base_path == '/'
+    end
+
+    # Returns base URL for specified operation based on server settings
+    def base_url(operation = nil)
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
+      if operation_server_settings.key?(operation) then
+        index = server_operation_index.fetch(operation, server_index)
+        server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      else
+        server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
+      end
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name, param_alias = nil)
+      key = @api_key[param_name]
+      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{key}"
+      else
+        key
+      end
+    end
+
+    # Gets access_token using access_token_getter or uses the static access_token
+    def access_token_with_refresh
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+        'BearerToken' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
+        'ApiKey' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'X-API-Key',
+            value: api_key_with_prefix('X-API-Key')
+          },
+        'Timestamp' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'X-Timestamp',
+            value: api_key_with_prefix('X-Timestamp')
+          },
+        'Signature' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'X-Signature',
+            value: api_key_with_prefix('X-Signature')
+          },
+      }
+    end
+
+    # Returns an array of Server setting
+    def server_settings
+      [
+        {
+          url: "https://api.example.com",
+          description: "Replace with your Tactic Chain API base URL",
+        }
+      ]
+    end
+
+    def operation_server_settings
+      {
+      }
+    end
+
+    # Returns URL based on server settings
+    #
+    # @param index array index of the server settings
+    # @param variables hash of variable and the corresponding value
+    def server_url(index, variables = {}, servers = nil)
+      servers = server_settings if servers == nil
+
+      # check array index out of bound
+      if (index.nil? || index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
+      end
+
+      server = servers[index]
+      url = server[:url]
+
+      return url unless server.key? :variables
+
+      # go through variable and assign a value
+      server[:variables].each do |name, variable|
+        if variables.key?(name)
+          if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
+            url.gsub! "{" + name.to_s + "}", variables[name]
+          else
+            fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
+          end
+        else
+          # use default value
+          url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+        end
+      end
+
+      url
+    end
+
+
+  end
+end

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

@@ -0,0 +1,341 @@
+=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 ApiDeclarationDeleteRequest < ApiModelBase
+    # 单个附件申报记录 ID。
+    attr_accessor :attachment_id
+
+    # 批量附件申报记录 ID。
+    attr_accessor :attachment_ids
+
+    # 单个表单申报记录 ID。
+    attr_accessor :form_data_id
+
+    # 批量表单申报记录 ID。
+    attr_accessor :form_data_ids
+
+    # 申报阶段 ID。按业务键删除申报资料时用于判断 ExtendNumber 属于哪类单据。
+    attr_accessor :stage_id
+
+    # 业务扩展 ID，例如订单 ID、生产单 ID、发货单 ID。
+    attr_accessor :extend_id
+
+    # 业务单号。可配合 ExtendDate、ExtendLineNumber、ProductCode 等字段解析 ExtendId。
+    attr_accessor :extend_number
+
+    # 业务单日期。订单阶段按订单号定位时使用。
+    attr_accessor :extend_date
+
+    # 订单行号。订单阶段按订单行定位时使用。
+    attr_accessor :extend_line_number
+
+    # 订单侧别，常用 PO 或 SO。
+    attr_accessor :order_side
+
+    # 产品编码。生产/入库阶段按生产单号删除申报资料时参与定位生产单。
+    attr_accessor :product_code
+
+    # 生产类型。生产/入库阶段按生产单号定位时参与唯一性判断。
+    attr_accessor :production_type
+
+    # 发货单号。发货阶段按单号删除申报资料时用于定位 ExtendId。
+    attr_accessor :delivery_number
+
+    # 资料类型 ID。按业务键删除时和 StageId、ExtendId 一起定位申报记录。
+    attr_accessor :document_type_id
+
+    # 资料类型编码。外部不知道 DocumentTypeId 时可传该字段。
+    attr_accessor :document_type_code
+
+    # 附件申报的单据编号；同一资料类型存在多条附件申报时用于进一步过滤。
+    attr_accessor :document_number
+
+    # 是否删除附件申报；默认 true。
+    attr_accessor :delete_attachments
+
+    # 是否删除表单申报；默认 true。
+    attr_accessor :delete_forms
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attachment_id' => :'attachmentId',
+        :'attachment_ids' => :'attachmentIds',
+        :'form_data_id' => :'formDataId',
+        :'form_data_ids' => :'formDataIds',
+        :'stage_id' => :'stageId',
+        :'extend_id' => :'extendId',
+        :'extend_number' => :'extendNumber',
+        :'extend_date' => :'extendDate',
+        :'extend_line_number' => :'extendLineNumber',
+        :'order_side' => :'orderSide',
+        :'product_code' => :'productCode',
+        :'production_type' => :'productionType',
+        :'delivery_number' => :'deliveryNumber',
+        :'document_type_id' => :'documentTypeId',
+        :'document_type_code' => :'documentTypeCode',
+        :'document_number' => :'documentNumber',
+        :'delete_attachments' => :'deleteAttachments',
+        :'delete_forms' => :'deleteForms'
+      }
+    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
+      {
+        :'attachment_id' => :'String',
+        :'attachment_ids' => :'Array<String>',
+        :'form_data_id' => :'String',
+        :'form_data_ids' => :'Array<String>',
+        :'stage_id' => :'String',
+        :'extend_id' => :'String',
+        :'extend_number' => :'String',
+        :'extend_date' => :'Time',
+        :'extend_line_number' => :'String',
+        :'order_side' => :'String',
+        :'product_code' => :'String',
+        :'production_type' => :'Integer',
+        :'delivery_number' => :'String',
+        :'document_type_id' => :'String',
+        :'document_type_code' => :'String',
+        :'document_number' => :'String',
+        :'delete_attachments' => :'Boolean',
+        :'delete_forms' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'attachment_id',
+        :'attachment_ids',
+        :'form_data_id',
+        :'form_data_ids',
+        :'stage_id',
+        :'extend_id',
+        :'extend_number',
+        :'extend_date',
+        :'extend_line_number',
+        :'order_side',
+        :'product_code',
+        :'production_type',
+        :'delivery_number',
+        :'document_type_id',
+        :'document_type_code',
+        :'document_number',
+        :'delete_attachments',
+        :'delete_forms'
+      ])
+    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::ApiDeclarationDeleteRequest` 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::ApiDeclarationDeleteRequest`. 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?(:'attachment_id')
+        self.attachment_id = attributes[:'attachment_id']
+      end
+
+      if attributes.key?(:'attachment_ids')
+        if (value = attributes[:'attachment_ids']).is_a?(Array)
+          self.attachment_ids = value
+        end
+      end
+
+      if attributes.key?(:'form_data_id')
+        self.form_data_id = attributes[:'form_data_id']
+      end
+
+      if attributes.key?(:'form_data_ids')
+        if (value = attributes[:'form_data_ids']).is_a?(Array)
+          self.form_data_ids = value
+        end
+      end
+
+      if attributes.key?(:'stage_id')
+        self.stage_id = attributes[:'stage_id']
+      end
+
+      if attributes.key?(:'extend_id')
+        self.extend_id = attributes[:'extend_id']
+      end
+
+      if attributes.key?(:'extend_number')
+        self.extend_number = attributes[:'extend_number']
+      end
+
+      if attributes.key?(:'extend_date')
+        self.extend_date = attributes[:'extend_date']
+      end
+
+      if attributes.key?(:'extend_line_number')
+        self.extend_line_number = attributes[:'extend_line_number']
+      end
+
+      if attributes.key?(:'order_side')
+        self.order_side = attributes[:'order_side']
+      end
+
+      if attributes.key?(:'product_code')
+        self.product_code = attributes[:'product_code']
+      end
+
+      if attributes.key?(:'production_type')
+        self.production_type = attributes[:'production_type']
+      end
+
+      if attributes.key?(:'delivery_number')
+        self.delivery_number = attributes[:'delivery_number']
+      end
+
+      if attributes.key?(:'document_type_id')
+        self.document_type_id = attributes[:'document_type_id']
+      end
+
+      if attributes.key?(:'document_type_code')
+        self.document_type_code = attributes[:'document_type_code']
+      end
+
+      if attributes.key?(:'document_number')
+        self.document_number = attributes[:'document_number']
+      end
+
+      if attributes.key?(:'delete_attachments')
+        self.delete_attachments = attributes[:'delete_attachments']
+      end
+
+      if attributes.key?(:'delete_forms')
+        self.delete_forms = attributes[:'delete_forms']
+      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 &&
+          attachment_id == o.attachment_id &&
+          attachment_ids == o.attachment_ids &&
+          form_data_id == o.form_data_id &&
+          form_data_ids == o.form_data_ids &&
+          stage_id == o.stage_id &&
+          extend_id == o.extend_id &&
+          extend_number == o.extend_number &&
+          extend_date == o.extend_date &&
+          extend_line_number == o.extend_line_number &&
+          order_side == o.order_side &&
+          product_code == o.product_code &&
+          production_type == o.production_type &&
+          delivery_number == o.delivery_number &&
+          document_type_id == o.document_type_id &&
+          document_type_code == o.document_type_code &&
+          document_number == o.document_number &&
+          delete_attachments == o.delete_attachments &&
+          delete_forms == o.delete_forms
+    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
+      [attachment_id, attachment_ids, form_data_id, form_data_ids, stage_id, extend_id, extend_number, extend_date, extend_line_number, order_side, product_code, production_type, delivery_number, document_type_id, document_type_code, document_number, delete_attachments, delete_forms].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