docusign_monitor 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb98deb53bd1d5db86fb98312656ac70f879679b51e004f001f2abcdce97a79d
-  data.tar.gz: db0edb0bb2c9a3b41898ef0ddc8e1d6f7fbf861e9ad9c7bf6520a1dc95375356
+  metadata.gz: 528f68adbdfd32aaee5309d739858c7bf7bf33d50ed93273be2952497a3476e6
+  data.tar.gz: 3a88085b1c80ecf5ce01a232c0f7de5fbc015fd1564cb981c2231563583ef279
 SHA512:
-  metadata.gz: 8debccc17dbbf1236c47fff577023646640272aec7c9d853fa9b7497672ebc233e7a6c0bf56aad831edcaf0a713467ad1fc4b6c0889f882175e8526ab84ed3ff
-  data.tar.gz: 336b5bbd1ee7426cacd15b56bdaaaa99153fe05fff67c3c7955c41cd17f26ff6dd51807f6d4891262d2e326d85ebeae0ef25d4d818770fe17818630335d0b1df
+  metadata.gz: 28317aed365ccc05c13a62d16d1cb190dc5db434e62fed2eba121f3d2f8eb73b07897f279b9d3283cfbf386ddcf877259905254e52f49c5f20ce0914798e308f
+  data.tar.gz: d657c0decdd89a18c5b289cd877fdd786cff8324acb83a29139bdde408fd73a9576c364470210575e00258075f18e988b3272e4baf7e20e58316b83159ad227f

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # DocuSign Monitor Ruby Client Changelog
 See [DocuSign Support Center](https://support.docusign.com/en/releasenotes/) for Product Release Notes.
 
+## [v1.2.0] - Monitor API v2.0-2.0.0 - 2023-06-14
+### Changed
+- Added support for version v2.0-2.0.0 of the DocuSign Monitor API.
+- Updated the SDK release version.
+
 ## [v1.1.0] - Monitor API v2.0-1.1.0 - 2022-04-11
 ### Changed
 - Added support for version v2.0-1.1.0 of the DocuSign Monitor API.

data/lib/docusign_monitor/api/data_set_api.rb

@@ -14,10 +14,10 @@ require "uri"
 module DocuSign_Monitor
 
   class GetStreamOptions
-    # The cursor value to continue querying the data with. For an intial call, use empty string
+    # Specifies a pointer into the dataset where your query will begin. You can either provide an ISO DateTime or a string cursor (from the `endCursor` value in the response). If no value is provided, the query begins from seven days ago.  For example, to fetch event data beginning from January 1, 2022, set this value to `2022-01-01T00:00:00Z`. The response will include data about events starting from that date in chronological order. The response also includes an `endCursor` property. To fetch the next page of event data, call this endpoint again with `cursor` set to the previous `endCursor` value. 
     attr_accessor :cursor
 
-    # The maximum number of records to return, minimum of 1, maximum of 2000. Defaults to 1000 if no value is provided
+    # The maximum number of records to return. The default value is 1000.
     attr_accessor :limit
 
     def self.default
@@ -33,10 +33,10 @@ module DocuSign_Monitor
       @api_client = api_client
     end
 
-    # 
-    # Allows for the streaming of data as it becomes available  Required scopes: impersonation
-    # @param data_set_name The name of the dataset to stream
-    # @param version The requested API version
+    # Gets customer event data for an organization.
+    # Gets customer event data for the organization that owns the integration key.  The results for this endpoint are paginated by event timestamp. Use the `cursor` parameter to specify where the query begins in the dataset. Use the `limit` parameter to set the number of records returned. 
+    # @param data_set_name Must be `monitor`.
+    # @param version Must be `2`. 
     # @param DocuSign_Monitor::GetStreamOptions Options for modifying the behavior of the function.
     # @return [CursoredResult]
     def get_stream(data_set_name, version, options = DocuSign_Monitor::GetStreamOptions.default)
@@ -44,10 +44,10 @@ module DocuSign_Monitor
       return data
     end
 
-    # 
-    # Allows for the streaming of data as it becomes available  Required scopes: impersonation
-    # @param data_set_name The name of the dataset to stream
-    # @param version The requested API version
+    # Gets customer event data for an organization.
+    # Gets customer event data for the organization that owns the integration key.  The results for this endpoint are paginated by event timestamp. Use the `cursor` parameter to specify where the query begins in the dataset. Use the `limit` parameter to set the number of records returned. 
+    # @param data_set_name Must be `monitor`.
+    # @param version Must be `2`. 
     # @param DocuSign_Monitor::GetStreamOptions Options for modifying the behavior of the function.
     # @return [Array<(CursoredResult, Fixnum, Hash)>] CursoredResult data, response status code and response headers
     def get_stream_with_http_info(data_set_name, version, options = DocuSign_Monitor::GetStreamOptions.default)
@@ -91,64 +91,5 @@ module DocuSign_Monitor
       end
       return data, status_code, headers
     end
-
-    # 
-    # Allows for querying existing data using filter and aggregation clauses  Required scopes: impersonation
-    # @param data_set_name The name of the dataset to query
-    # @param version The requested API version
-    # @param web_query A collection of filter clauses and aggregations scoped to one or more organizations. The fields queryScope and queryScopeId may be omitted defaulting to all applicable organizations 
-    # @return [AggregateResult]
-    def post_web_query(data_set_name, version, web_query)
-      data, _status_code, _headers = post_web_query_with_http_info(data_set_name, version,  web_query)
-      return data
-    end
-
-    # 
-    # Allows for querying existing data using filter and aggregation clauses  Required scopes: impersonation
-    # @param data_set_name The name of the dataset to query
-    # @param version The requested API version
-    # @param web_query A collection of filter clauses and aggregations scoped to one or more organizations. The fields queryScope and queryScopeId may be omitted defaulting to all applicable organizations 
-    # @return [Array<(AggregateResult, Fixnum, Hash)>] AggregateResult data, response status code and response headers
-    def post_web_query_with_http_info(data_set_name, version, web_query)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: DataSetApi.post_web_query ..."
-      end
-      # verify the required parameter 'data_set_name' is set
-      fail ArgumentError, "Missing the required parameter 'data_set_name' when calling DataSetApi.post_web_query" if data_set_name.nil?
-      # verify the required parameter 'version' is set
-      fail ArgumentError, "Missing the required parameter 'version' when calling DataSetApi.post_web_query" if version.nil?
-      # verify the required parameter 'web_query' is set
-      fail ArgumentError, "Missing the required parameter 'web_query' when calling DataSetApi.post_web_query" if web_query.nil?
-      # resource path
-      local_var_path = "/api/v{version}/datasets/{dataSetName}/web_query".sub('{format}','json').sub('{' + 'dataSetName' + '}', data_set_name.to_s).sub('{' + 'version' + '}', version.to_s)
-
-      # query parameters
-      query_params = {}
-
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-
-      # form parameters
-      form_params = {}
-
-      # http body (model)
-      post_body = @api_client.object_to_http_body(web_query)
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'AggregateResult')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: DataSetApi#post_web_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
   end
 end

data/lib/docusign_monitor/client/api_client.rb

@@ -35,7 +35,7 @@ module DocuSign_Monitor
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "Swagger-Codegen/1.1.0/ruby"
+      @user_agent = "Swagger-Codegen/1.2.0/ruby"
       @default_headers = {
         'Content-Type' => "application/json",
         'User-Agent' => @user_agent
@@ -106,7 +106,7 @@ module DocuSign_Monitor
 
       # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
       _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
-
+      
       req_opts = {
         :method => http_method,
         :headers => header_params,
@@ -281,7 +281,12 @@ module DocuSign_Monitor
             # let typhoeus handle File, Array and nil parameters
             data[key] = value
           else
-            data[key] = value.to_s
+            if header_params['Content-Type'] == 'multipart/form-data'
+              header_params['Content-Disposition'] = 'form-data; name=file; filename=' + key
+              data = value
+            else
+              data[key] = value.to_s
+            end
           end
         end
       elsif body

data/lib/docusign_monitor/models/cursored_result.rb

@@ -12,9 +12,12 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 require 'date'
 
 module DocuSign_Monitor
+  # 
   class CursoredResult
+    # 
     attr_accessor :end_cursor
 
+    # 
     attr_accessor :data
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/docusign_monitor/models/data_set.rb

@@ -0,0 +1,197 @@
+=begin
+#Monitor API
+
+#An API for an integrator to access the features of DocuSign Monitor
+
+OpenAPI spec version: v2.0
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module DocuSign_Monitor
+  # Methods to fetch organization event data.
+  class DataSet
+    # 
+    attr_accessor :end_cursor
+
+    # 
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'end_cursor' => :'endCursor',
+        :'data' => :'data'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'end_cursor' => :'String',
+        :'data' => :'Array<Object>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'endCursor')
+        self.end_cursor = attributes[:'endCursor']
+      end
+
+      if attributes.has_key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      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
+      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?
+      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 &&
+          end_cursor == o.end_cursor &&
+          data == o.data
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [end_cursor, data].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = DocuSign_Monitor.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/docusign_monitor/version.rb

@@ -10,5 +10,5 @@ Generated by: https://github.com/swagger-api/swagger-codegen.git
 =end
 
 module DocuSign_Monitor
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/docusign_monitor.rb

@@ -19,10 +19,8 @@ require 'docusign_monitor/configuration'
 require 'docusign_monitor/client/auth/oauth'
 
 # Models
-require 'docusign_monitor/models/aggregate_result'
-require 'docusign_monitor/models/aggregate_result_result'
 require 'docusign_monitor/models/cursored_result'
-require 'docusign_monitor/models/web_query'
+require 'docusign_monitor/models/data_set'
 
 # APIs
 require 'docusign_monitor/api/data_set_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docusign_monitor
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - DocuSign
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -296,6 +296,7 @@ files:
 - lib/docusign_monitor/models/aggregate_result_result.rb
 - lib/docusign_monitor/models/aggregation.rb
 - lib/docusign_monitor/models/cursored_result.rb
+- lib/docusign_monitor/models/data_set.rb
 - lib/docusign_monitor/models/filter.rb
 - lib/docusign_monitor/models/raw_request.rb
 - lib/docusign_monitor/models/web_query.rb