assinafy 2.0.1 → 2.1.1

data/lib/assinafy/resources/webhook_resource.rb

@@ -28,7 +28,8 @@ module Assinafy
       # @option payload [Array<String>] :events    event-type IDs (see {#list_event_types})
       # @option payload [Boolean]       :is_active default `true` when omitted
       # @param account_id_override [String, nil]
-      # @return [Hash] the subscription object: { events:, is_active:, url:, email:, updated_at: }
+      # @return [Hash] the subscription object: { events:, is_active:, is_held:, held_since:, url:, email:,
+      #   updated_at: }
       # @raise [Assinafy::ApiError] on an unsuccessful API response
       # @raise [Assinafy::NetworkError] on transport or TLS failure
       # @raise [Assinafy::ValidationError] on invalid required input
@@ -51,6 +52,8 @@ module Assinafy
       #   # {
       #   #   'events' => ["document_ready", "document_prepared"],
       #   #   'is_active' => true,
+      #   #   'is_held' => false,
+      #   #   'held_since' => nil,
       #   #   'url' => "https://example.com/webhook",
       #   #   'email' => "ops@example.com",
       #   #   'updated_at' => "2026-06-05T21:13:24Z"
@@ -84,6 +87,8 @@ module Assinafy
       #   # {
       #   #   'events' => ["document_ready", "signer_signed_document"],
       #   #   'is_active' => false,
+      #   #   'is_held' => false,
+      #   #   'held_since' => nil,
       #   #   'url' => "https://example.com/sdk-smoke-webhook",
       #   #   'email' => "webhook@example.com",
       #   #   'updated_at' => "2026-06-05T21:13:24Z"
@@ -113,6 +118,8 @@ module Assinafy
       #   # {
       #   #   'events' => ["document_ready", "document_prepared"],
       #   #   'is_active' => false,
+      #   #   'is_held' => false,
+      #   #   'held_since' => nil,
       #   #   'url' => "https://example.com/webhook",
       #   #   'email' => "ops@example.com",
       #   #   'updated_at' => "2026-06-05T21:13:24Z"
@@ -178,6 +185,10 @@ module Assinafy
       #   #       endpoint:      "https://example.com/webhook",
       #   #       payload:       { 'id' => 15431, event: "signature_requested", object: {}, subject: {}, payload: {} },
       #   #       delivered:     false,
+      #   #       webhook_id:    "webhook-id-placeholder",
+      #   #       attempt:       2,
+      #   #       kind:          "scheduled",
+      #   #       will_retry:    false,
       #   #       http_status:   404,
       #   #       response_body: "{\"success\":false,...}",
       #   #       error:         "Client error: `POST https://example.com/webhook` resulted in a 404 ...",
@@ -217,6 +228,10 @@ module Assinafy
       #   #   endpoint:      "https://example.com/webhook",
       #   #   payload:       { 'id' => 15431, event: "signature_requested", object: {}, subject: {} },
       #   #   delivered:     true,
+      #   #   webhook_id:    "webhook-id-placeholder",
+      #   #   attempt:       1,
+      #   #   kind:          "manual",
+      #   #   will_retry:    false,
       #   #   http_status:   200,
       #   #   response_body: "OK",
       #   #   error:         nil,
@@ -247,12 +262,15 @@ module Assinafy
       #   # => unwrapped data payload returned:
       #   # [
       #   #   {
+      #   #     'resource' => "activity_event_subscription",
       #   #     'id' => "webhook-endpoint-id",
       #   #     'name' => "ERP",
       #   #     'url' => "https://example.com/webhooks/assinafy",
       #   #     'email' => "ops@example.com",
       #   #     'events' => ["document_ready", "signer_signed_document"],
       #   #     'is_active' => true,
+      #   #     'is_held' => false,
+      #   #     'held_since' => nil,
       #   #     'signing_enabled' => true,
       #   #     'created_at' => "2026-10-01T12:00:00Z",
       #   #     'updated_at' => "2026-10-01T12:00:00Z"
@@ -274,7 +292,7 @@ module Assinafy
       # especially for OAuth apps, which cannot call {#endpoint_secret}.
       #
       # @param payload [Hash]
-      # @option payload [String]        :url             http(s) URL that receives the events (required)
+      # @option payload [String]        :url             HTTPS URL that receives the events (required)
       # @option payload [String]        :email           contact email for delivery-failure notices (required)
       # @option payload [Array<String>] :events          event-type IDs (see {#list_event_types}) (required)
       # @option payload [String]        :name            label to tell endpoints apart
@@ -304,8 +322,10 @@ module Assinafy
       #   #   "signing_enabled": true
       #   # }
       #   # => unwrapped data payload returned (same shape as {#list_endpoints} entries):
-      #   # { 'id' => "webhook-endpoint-id", 'name' => "ERP", 'url' => "https://example.com/webhooks/assinafy",
-      #   #   'email' => "ops@example.com", 'events' => [...], 'is_active' => true, 'signing_enabled' => true,
+      #   # { 'resource' => "activity_event_subscription", 'id' => "webhook-endpoint-id", 'name' => "ERP",
+      #   #   'url' => "https://example.com/webhooks/assinafy", 'email' => "ops@example.com",
+      #   #   'events' => [...], 'is_active' => true, 'is_held' => false, 'held_since' => nil,
+      #   #   'signing_enabled' => true,
       #   #   'created_at' => "2026-10-01T12:00:00Z", 'updated_at' => "2026-10-01T12:00:00Z",
       #   #   'secret' => 'whsec_secret-placeholder' } # secret appears only on creation with signing enabled
       def create_endpoint(payload, account_id_override = nil)
@@ -481,7 +501,7 @@ module Assinafy
       end
 
       def validate_webhook_fields!(body)
-        require_string(body[:url], 'Webhook URL') if body.key?(:url)
+        validate_webhook_url!(body[:url]) if body.key?(:url)
         Utils.require_email(body[:email]) if body.key?(:email)
         require_string(body[:name], 'Webhook name') if body.key?(:name)
         %i[is_active signing_enabled].each { |key| require_boolean(body[key], key.to_s) if body.key?(key) }
@@ -492,6 +512,16 @@ module Assinafy
 
         raise ValidationError.new('Webhook events must be non-empty Strings')
       end
+
+      def validate_webhook_url!(value)
+        url = require_string(value, 'Webhook URL')
+        uri = URI.parse(url)
+        return if uri.is_a?(URI::HTTPS) && uri.host && !uri.host.empty?
+
+        raise ValidationError.new('Webhook URL must be an absolute HTTPS URL')
+      rescue URI::InvalidURIError
+        raise ValidationError.new('Webhook URL must be an absolute HTTPS URL')
+      end
     end
   end
 end

data/lib/assinafy/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Assinafy
-  VERSION = '2.0.1'
+  VERSION = '2.1.1'
   USER_AGENT = "Assinafy-Ruby-SDK/v#{VERSION}".freeze
 end

data/lib/assinafy.rb

@@ -17,6 +17,7 @@ require_relative 'assinafy/resources/oauth_resource'
 require_relative 'assinafy/resources/account_resource'
 require_relative 'assinafy/resources/user_resource'
 require_relative 'assinafy/resources/document_resource'
+require_relative 'assinafy/resources/contract_resource'
 require_relative 'assinafy/resources/signer_resource'
 require_relative 'assinafy/resources/signer_document_resource'
 require_relative 'assinafy/resources/assignment_resource'

data/sig/assinafy.rbs

@@ -283,6 +283,23 @@ module Assinafy
       def signing_progress: (String document_id) -> signing_progress
     end
 
+    class ContractResource < BaseResource
+      STATUSES: Array[String]
+      RELATION_TYPES: Array[String]
+      SORTS: Array[String]
+      LIST_FIELDS: Array[String]
+      UPDATE_FIELDS: Array[String]
+      RENEW_FIELDS: Array[String]
+      TERMINATE_FIELDS: Array[String]
+
+      def list: (?params params, ?String? account_id_override) -> list_result
+      def get: (String document_id, ?String? account_id_override) -> api_object?
+      def update: (String document_id, params payload, ?String? account_id_override) -> api_object
+      def related: (String document_id, ?String? account_id_override) -> api_object?
+      def renew: (String document_id, params payload, ?String? account_id_override) -> api_object
+      def terminate: (String document_id, ?params payload, ?String? account_id_override) -> api_object
+    end
+
     class SignerResource < BaseResource
       EMAIL_REGEX: Regexp
       SIGNATURE_TYPES: Array[String]
@@ -445,6 +462,7 @@ module Assinafy
     attr_reader accounts: Resources::AccountResource
     attr_reader users: Resources::UserResource
     attr_reader documents: Resources::DocumentResource
+    attr_reader contracts: Resources::ContractResource
     attr_reader signers: Resources::SignerResource
     attr_reader signer_documents: Resources::SignerDocumentResource
     attr_reader assignments: Resources::AssignmentResource

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assinafy
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Assinafy SDK Contributors
@@ -134,8 +134,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Ruby SDK for Assinafy. Covers the documented authentication, OAuth 2.1,
-  account, user, document, signer, assignment, webhook, template, tag, and field APIs,
-  plus the high-level upload_and_request_signatures helper.
+  account, user, document, contract, signer, assignment, webhook, template, tag, and
+  field APIs, plus the high-level upload_and_request_signatures helper.
 email:
 - sdk@assinafy.com.br
 executables: []
@@ -157,6 +157,7 @@ files:
 - lib/assinafy/resources/assignment_resource.rb
 - lib/assinafy/resources/auth_resource.rb
 - lib/assinafy/resources/base_resource.rb
+- lib/assinafy/resources/contract_resource.rb
 - lib/assinafy/resources/document_resource.rb
 - lib/assinafy/resources/field_resource.rb
 - lib/assinafy/resources/oauth_resource.rb