didit-sdk 1.0.0

data/sig/didit/types/webhooks.rbs

@@ -0,0 +1,311 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    module WebhooksDestinationsCreateParamsWebhookVersion
+      V1: String
+      V2: String
+      V3: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsCreateResponseEnvironment
+      LIVE: String
+      SANDBOX: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsCreateResponseHealthStatus
+      HEALTHY: String
+      DEGRADED: String
+      FAILING: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsCreateResponseWebhookVersion
+      V1: String
+      V2: String
+      V3: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsListResponseItemEnvironment
+      LIVE: String
+      SANDBOX: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsListResponseItemHealthStatus
+      HEALTHY: String
+      DEGRADED: String
+      FAILING: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsListResponseItemWebhookVersion
+      V1: String
+      V2: String
+      V3: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsRetrieveResponseEnvironment
+      LIVE: String
+      SANDBOX: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsRetrieveResponseHealthStatus
+      HEALTHY: String
+      DEGRADED: String
+      FAILING: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsRetrieveResponseWebhookVersion
+      V1: String
+      V2: String
+      V3: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsUpdateParamsWebhookVersion
+      V1: String
+      V2: String
+      V3: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsUpdateResponseEnvironment
+      LIVE: String
+      SANDBOX: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsUpdateResponseHealthStatus
+      HEALTHY: String
+      DEGRADED: String
+      FAILING: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksDestinationsUpdateResponseWebhookVersion
+      V1: String
+      V2: String
+      V3: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksUpdateConfigParamsBiometricConsentMode
+      AUTO: String
+      ALWAYS: String
+      NEVER: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksUpdateConfigParamsCaptureMethod
+      MOBILE: String
+      MOBILE_AND_DESKTOP: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksUpdateConfigParamsFaceRetentionPolicy
+      DELETE_WITH_SESSION: String
+      RETAIN_UNTIL_USER_DELETED: String
+
+      VALUES: Array[String]
+    end
+
+    module WebhooksUpdateConfigParamsWebhookVersion
+      V1: String
+      V2: String
+      V3: String
+
+      VALUES: Array[String]
+    end
+
+    class WebhooksDestinationsCreateResponse < Didit::Model
+      def uuid: () -> String?
+      def label: () -> String?
+      def url: () -> String?
+      def enabled: () -> bool?
+      def webhook_version: () -> String?
+      def secret_shared_key: () -> String?
+      def secret_last4: () -> String?
+      def previous_secret_expires_at: () -> Time?
+      def subscribed_events: () -> Array[String]?
+      def created_by_email: () -> String?
+      def created_by_name: () -> String?
+      def created_at: () -> Time?
+      def updated_at: () -> Time?
+      def health_status: () -> String?
+      def failing_streak: () -> Integer?
+      def failing_since: () -> Time?
+      def last_success_at: () -> Time?
+      def environment: () -> String?
+      def summary: () -> Didit::Types::WebhooksDestinationsCreateResponseSummary?
+    end
+
+    class WebhooksDestinationsCreateResponseSummary < Didit::Model
+      def total_deliveries: () -> Integer?
+      def failed_deliveries: () -> Integer?
+      def error_rate_percentage: () -> Integer?
+      def min_response_time_ms: () -> Integer?
+      def avg_response_time_ms: () -> Integer?
+      def max_response_time_ms: () -> Integer?
+      def last_delivery_at: () -> Time?
+      def metrics_window_days: () -> Integer?
+    end
+
+    class WebhooksDestinationsListDeliveriesResponse < Didit::Model
+      def count: () -> Integer
+      def `next`: () -> String?
+      def previous: () -> String?
+      def results: () -> Array[Didit::Types::WebhookDestinationDelivery]
+    end
+
+    class WebhooksDestinationsListResponseItem < Didit::Model
+      def uuid: () -> String?
+      def label: () -> String?
+      def url: () -> String?
+      def enabled: () -> bool?
+      def webhook_version: () -> String?
+      def subscribed_events: () -> Array[String]?
+      def subscribed_events_count: () -> Integer?
+      def deliveries_count: () -> Integer?
+      def failed_deliveries_count: () -> Integer?
+      def average_response_time_ms: () -> Integer?
+      def error_rate_percentage: () -> Integer?
+      def last_delivery_at: () -> Time?
+      def metrics_window_days: () -> Integer?
+      def health_status: () -> String?
+      def failing_streak: () -> Integer?
+      def failing_since: () -> Time?
+      def last_success_at: () -> Time?
+      def environment: () -> String?
+      def daily_points: () -> Array[Didit::Types::WebhooksDestinationsListResponseItemDailyPoints]?
+      def secret_last4: () -> String?
+      def created_by_email: () -> String?
+      def created_by_name: () -> String?
+      def created_at: () -> Time?
+      def updated_at: () -> Time?
+    end
+
+    class WebhooksDestinationsListResponseItemDailyPoints < Didit::Model
+      def date: () -> Date?
+      def total_deliveries: () -> Integer?
+      def failed_deliveries: () -> Integer?
+    end
+
+    class WebhooksDestinationsRetrieveAnalyticsResponse < Didit::Model
+      def summary: () -> Didit::Types::WebhooksDestinationsRetrieveAnalyticsResponseSummary
+      def points: () -> Array[Didit::Types::WebhooksDestinationsRetrieveAnalyticsResponsePoints]
+    end
+
+    class WebhooksDestinationsRetrieveAnalyticsResponsePoints < Didit::Model
+      def date: () -> Date
+      def total_deliveries: () -> Integer
+      def failed_deliveries: () -> Integer
+      def min_response_time_ms: () -> Integer?
+      def avg_response_time_ms: () -> Integer?
+      def max_response_time_ms: () -> Integer?
+    end
+
+    class WebhooksDestinationsRetrieveAnalyticsResponseSummary < Didit::Model
+      def total_deliveries: () -> Integer
+      def failed_deliveries: () -> Integer
+      def min_response_time_ms: () -> Integer?
+      def avg_response_time_ms: () -> Integer?
+      def max_response_time_ms: () -> Integer?
+      def error_rate_percentage: () -> Integer
+    end
+
+    class WebhooksDestinationsRetrieveResponse < Didit::Model
+      def uuid: () -> String?
+      def label: () -> String?
+      def url: () -> String?
+      def enabled: () -> bool?
+      def webhook_version: () -> String?
+      def secret_shared_key: () -> String?
+      def secret_last4: () -> String?
+      def previous_secret_expires_at: () -> Time?
+      def subscribed_events: () -> Array[String]?
+      def created_by_email: () -> String?
+      def created_by_name: () -> String?
+      def created_at: () -> Time?
+      def updated_at: () -> Time?
+      def health_status: () -> String?
+      def failing_streak: () -> Integer?
+      def failing_since: () -> Time?
+      def last_success_at: () -> Time?
+      def environment: () -> String?
+      def summary: () -> Didit::Types::WebhooksDestinationsRetrieveResponseSummary?
+    end
+
+    class WebhooksDestinationsRetrieveResponseSummary < Didit::Model
+      def total_deliveries: () -> Integer?
+      def failed_deliveries: () -> Integer?
+      def error_rate_percentage: () -> Integer?
+      def min_response_time_ms: () -> Integer?
+      def avg_response_time_ms: () -> Integer?
+      def max_response_time_ms: () -> Integer?
+      def last_delivery_at: () -> Time?
+      def metrics_window_days: () -> Integer?
+    end
+
+    class WebhooksDestinationsUpdateResponse < Didit::Model
+      def uuid: () -> String?
+      def label: () -> String?
+      def url: () -> String?
+      def enabled: () -> bool?
+      def webhook_version: () -> String?
+      def secret_shared_key: () -> String?
+      def secret_last4: () -> String?
+      def previous_secret_expires_at: () -> Time?
+      def subscribed_events: () -> Array[String]?
+      def created_by_email: () -> String?
+      def created_by_name: () -> String?
+      def created_at: () -> Time?
+      def updated_at: () -> Time?
+      def health_status: () -> String?
+      def failing_streak: () -> Integer?
+      def failing_since: () -> Time?
+      def last_success_at: () -> Time?
+      def environment: () -> String?
+      def summary: () -> Didit::Types::WebhooksDestinationsUpdateResponseSummary?
+    end
+
+    class WebhooksDestinationsUpdateResponseSummary < Didit::Model
+      def total_deliveries: () -> Integer?
+      def failed_deliveries: () -> Integer?
+      def error_rate_percentage: () -> Integer?
+      def min_response_time_ms: () -> Integer?
+      def avg_response_time_ms: () -> Integer?
+      def max_response_time_ms: () -> Integer?
+      def last_delivery_at: () -> Time?
+      def metrics_window_days: () -> Integer?
+    end
+
+    type webhooks_destinations_create_params = { label: String, url: String, ?enabled: bool, ?webhook_version: String, ?subscribed_events: Array[String] }
+
+    type webhooks_destinations_update_params = { ?label: String, ?url: String, ?enabled: bool, ?webhook_version: String, ?subscribed_events: Array[String] }
+
+    type webhooks_update_config_params = { ?webhook_url: String?, ?webhook_version: String, ?rotate_secret_key: bool, ?capture_method: String, ?data_retention_months: Integer?, ?face_retention_policy: String, ?face_retention_days: Integer?, ?biometric_consent_mode: String, ?allowed_return_hosts: Array[String] }
+  end
+end

data/sig/didit/types/workflows.rbs

@@ -0,0 +1,30 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    module WorkflowsCreateParamsStatus
+      DRAFT: String
+      PUBLISHED: String
+
+      VALUES: Array[String]
+    end
+
+    module WorkflowsUpdateParamsStatus
+      DRAFT: String
+      PUBLISHED: String
+
+      VALUES: Array[String]
+    end
+
+    class WorkflowsListResponse < Didit::Model
+      def count: () -> Integer?
+      def `next`: () -> String?
+      def previous: () -> String?
+      def results: () -> Array[Didit::Types::WorkflowListItem]?
+    end
+
+    type workflows_create_params = { ?workflow_label: String, ?is_default: bool, ?status: String, features: Array[Didit::Types::simple_workflow_feature], ?is_white_label_enabled: bool, ?is_desktop_allowed: bool, ?max_retry_attempts: Integer, ?retry_window_days: Integer?, ?face_liveness_max_attempts: Integer, ?face_match_max_attempts: Integer, ?session_expiration_time: Integer }
+
+    type workflows_update_params = { ?workflow_label: String, ?is_default: bool, ?status: String, ?features: Array[Didit::Types::simple_workflow_feature], ?is_white_label_enabled: bool, ?is_desktop_allowed: bool, ?max_retry_attempts: Integer, ?retry_window_days: Integer?, ?face_liveness_max_attempts: Integer, ?face_match_max_attempts: Integer, ?session_expiration_time: Integer }
+  end
+end

data/sig/didit/webhooks/canonical_json.rbs

@@ -0,0 +1,25 @@
+module Didit
+  module Webhooks
+    module CanonicalJson
+      MAX_NESTING: Integer
+      ESCAPES: Hash[String, String]
+      ESCAPED: Regexp
+
+      def self?.generate: (untyped value) -> String
+      def self?.normalize: (untyped value, ?Integer depth) -> untyped
+      def self?.dump: (untyped value) -> String
+      def self?.python_str: (untyped value) -> String?
+      def self?.float_repr: (Float value) -> String
+      def self?.decimal_digits: (String text) -> [String, Integer]
+      def self?.format_repr: (String digits, Integer point) -> String
+      def self?.normalize_object: (Hash[untyped, untyped] value, Integer depth) -> Hash[String, untyped]
+      def self?.normalize_array: (Array[untyped] value, Integer depth) -> Array[untyped]
+      def self?.key_name: (untyped key) -> String
+      def self?.utf8: (String value) -> String
+      def self?.write: (untyped value, String out) -> String
+      def self?.write_object: (Hash[String, untyped] value, String out) -> String
+      def self?.write_array: (Array[untyped] value, String out) -> String
+      def self?.write_string: (String value, String out) -> String
+    end
+  end
+end

data/sig/didit/webhooks/client_methods.rbs

@@ -0,0 +1,11 @@
+module Didit
+  module Webhooks
+    module ClientMethods
+      def verify: (String raw_body, Webhooks::headers headers, Webhooks::secret secret, ?tolerance: Webhooks::tolerance,
+                   ?allow_simple: bool, ?now: (Integer | Float)?) -> Event
+
+      def verify_parsed: (Hash[String | Symbol, untyped] payload, Webhooks::headers headers, Webhooks::secret secret,
+                          ?tolerance: Webhooks::tolerance, ?now: (Integer | Float)?) -> Event
+    end
+  end
+end

data/sig/didit/webhooks/events.rbs

@@ -0,0 +1,125 @@
+module Didit
+  module Webhooks
+    EVENT_CLASSES: Hash[String, singleton(Event)]
+
+    class Event < Didit::Model
+      @verified_by: String?
+
+      def self.build: (Hash[untyped, untyped] payload, ?String? verified_by) -> Event
+
+      attr_reader verified_by: String?
+
+      def initialize: (?Hash[String | Symbol, untyped] data, ?verified_by: String?) -> void
+      def event_id: () -> String?
+      def webhook_type: () -> String?
+      def timestamp: () -> Integer?
+      def created_at: () -> Integer?
+      def application_id: () -> String?
+      def environment: () -> String?
+      def body_authenticated?: () -> bool
+    end
+
+    class SessionEvent < Event
+      def session_id: () -> String?
+      def business_session_id: () -> String?
+      def session_kind: () -> String?
+      def status: () -> String?
+      def workflow_id: () -> String?
+      def workflow_version: () -> untyped
+      def vendor_data: () -> String?
+      def metadata: () -> untyped
+      def decision: () -> Didit::Types::SessionDecision?
+      def resubmit_info: () -> untyped
+    end
+
+    class StatusUpdatedEvent < SessionEvent
+      WEBHOOK_TYPE: String
+    end
+
+    class DataUpdatedEvent < SessionEvent
+      WEBHOOK_TYPE: String
+    end
+
+    class UserEvent < Event
+      def vendor_user_id: () -> String?
+      def vendor_data: () -> String?
+      def status: () -> String?
+    end
+
+    class UserStatusUpdatedEvent < UserEvent
+      WEBHOOK_TYPE: String
+    end
+
+    class UserDataUpdatedEvent < UserEvent
+      WEBHOOK_TYPE: String
+    end
+
+    class BusinessEvent < Event
+      def vendor_business_id: () -> String?
+      def vendor_data: () -> String?
+      def status: () -> String?
+    end
+
+    class BusinessStatusUpdatedEvent < BusinessEvent
+      WEBHOOK_TYPE: String
+    end
+
+    class BusinessDataUpdatedEvent < BusinessEvent
+      WEBHOOK_TYPE: String
+    end
+
+    class TransactionEvent < Event
+      def transaction_id: () -> String?
+      def txn_id: () -> String?
+      def status: () -> String?
+      def score: () -> Float?
+      def severity: () -> String?
+      def amount: () -> untyped
+      def currency: () -> String?
+      def direction: () -> String?
+      def action_required: () -> bool?
+    end
+
+    class TransactionCreatedEvent < TransactionEvent
+      WEBHOOK_TYPE: String
+    end
+
+    class TransactionStatusUpdatedEvent < TransactionEvent
+      WEBHOOK_TYPE: String
+    end
+
+    class TravelRuleStatusUpdatedEvent < Event
+      WEBHOOK_TYPE: String
+
+      def transaction_id: () -> String?
+      def txn_id: () -> String?
+      def travel_rule_status: () -> String?
+      def rail: () -> String?
+      def direction: () -> String?
+    end
+
+    class ActivityCreatedEvent < Event
+      WEBHOOK_TYPE: String
+    end
+
+    class WorkflowComplianceChangedEvent < Event
+      WEBHOOK_TYPE: String
+
+      def workflow_id: () -> String?
+    end
+
+    class KybRegistrySearchResolvedEvent < Event
+      WEBHOOK_TYPE: String
+
+      def request_id: () -> String?
+      def vendor_data: () -> String?
+      def metadata: () -> untyped
+      def search_status: () -> String?
+      def search_resolved: () -> bool?
+      def kyb_registry: () -> untyped
+    end
+
+    class UnknownEvent < Event
+    end
+  end
+end

data/sig/didit/webhooks/headers.rbs

@@ -0,0 +1,22 @@
+module Didit
+  module Webhooks
+    class Headers
+      WANTED: Array[String]
+      HEX: Regexp
+
+      @values: Hash[String, Array[String]]
+
+      def initialize: (untyped source) -> void
+      def present?: (String name) -> bool
+      def signatures: (String name) -> Array[String]
+      def timestamp: () -> String?
+
+      private
+
+      def add: (untyped name, untyped value) -> void
+      def header_key: (untyped name) -> String?
+      def values: (String name) -> Array[String]
+      def parts: (String name) -> Array[String]
+    end
+  end
+end

data/sig/didit/webhooks/verifier.rbs

@@ -0,0 +1,54 @@
+module Didit
+  module Webhooks
+    class Verifier
+      FULL_BODY: Array[String]
+      CANONICAL: Array[String]
+      SIMPLE: Array[String]
+      ALL: Array[String]
+      SIMPLE_FIELDS: Array[String]
+      MAX_TIMESTAMP: Integer
+      TIMESTAMP_HEADER: Regexp
+      DUPLICATE_KEY_OPTION: bool
+      PARSE_OPTIONS: Hash[Symbol, bool]
+
+      type kind = :raw | :canonical | :simple
+
+      @keys: Array[String]
+      @tolerance: Webhooks::tolerance
+      @now: Integer | Float
+      @headers: Headers
+      @raw: String?
+      @payload: Hash[String, untyped]?
+      @digests: Hash[[String, kind], String]
+      @canonical: String?
+      @simple_message: String?
+
+      def initialize: (untyped secret, untyped headers, tolerance: untyped, now: untyped) -> void
+      def verify: (untyped raw_body, allow_simple: bool) -> Event
+      def verify_parsed: (untyped payload) -> Event
+
+      private
+
+      def payload: () -> Hash[String, untyped]
+      def secret_keys: (untyped secret) -> Array[String]
+      def key_bytes: (untyped secret) -> String
+      def check_tolerance: (untyped tolerance) -> Webhooks::tolerance
+      def check_now: (untyped now) -> (Integer | Float)
+      def body_bytes: (untyped raw_body) -> String
+      def parse_json: (String bytes) -> Hash[untyped, untyped]
+      def normalize: (untyped value) -> Hash[String, untyped]
+      def check_signatures: (Array[String] checked) -> String
+      def check_timestamp: () -> void
+      def check_timestamp_header: (Integer timestamp) -> void
+      def match: (Array[String] checked) -> String?
+      def signed?: (String key, String name) -> bool
+      def digest: (String key, String name) -> String
+      def message_kind: (String name) -> kind
+      def message: (kind kind) -> String
+      def canonical: () -> String
+      def simple_message: () -> String?
+      def no_match: (Array[String] checked) -> WebhookVerificationError
+      def failure: (Symbol reason, String message) -> WebhookVerificationError
+    end
+  end
+end

data/sig/didit/webhooks.rbs

@@ -0,0 +1,37 @@
+module Didit
+  module Webhooks
+    DEFAULT_TOLERANCE: Integer
+
+    HEADER_SIGNATURE: String
+    HEADER_SIGNATURE_V2: String
+    HEADER_SIGNATURE_SIMPLE: String
+    HEADER_SIGNATURE_PREVIOUS: String
+    HEADER_SIGNATURE_V2_PREVIOUS: String
+    HEADER_SIGNATURE_SIMPLE_PREVIOUS: String
+    HEADER_TIMESTAMP: String
+
+    # Anything whose +each+ yields [name, value] pairs: a Rack env, Rails request.headers, Net::HTTPHeader.
+    interface _EachHeader
+      def each: () { (untyped name, untyped value) -> void } -> untyped
+    end
+
+    # Request headers: names in any case, values Strings or Arrays of Strings.
+    type headers = Hash[untyped, untyped] | Array[[untyped, untyped]] | _EachHeader
+
+    # One secret, or several during a rotation.
+    type secret = String | Array[String]
+
+    # Seconds.
+    type tolerance = Integer | Float
+
+    def self.verify: (String raw_body, headers headers, secret secret, ?tolerance: tolerance, ?allow_simple: bool,
+                      ?now: (Integer | Float)?) -> Event
+
+    def self.verify_parsed: (Hash[String | Symbol, untyped] payload, headers headers, secret secret,
+                             ?tolerance: tolerance, ?now: (Integer | Float)?) -> Event
+
+    def self.canonical_json: (untyped value) -> String
+
+    def self.parse_event: (Hash[String | Symbol, untyped] payload) -> Event
+  end
+end

data/sig/didit.rbs

@@ -0,0 +1,20 @@
+module Didit
+  VERSION: String
+
+  OMIT: untyped
+
+  # A file argument of an upload operation.
+  type upload = Didit::FilePart | Pathname | IO | StringIO | String
+
+  # The +request_options:+ argument of every method.
+  type request_options = {
+    ?timeout: Numeric,
+    ?max_retries: Integer,
+    ?extra_headers: Hash[String, String?],
+    ?extra_query: Hash[String | Symbol, untyped],
+    ?extra_body: Hash[String | Symbol, untyped]
+  }
+
+  # A runtime type spec understood by Didit::Model.coerce.
+  type type_spec = Symbol | String | Class | Array[untyped] | Hash[Integer, untyped]
+end