didit-sdk 1.0.0

data/lib/didit/types/webhooks.rb

@@ -0,0 +1,355 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Payload schema version Didit will send. `v3` is the current/recommended format; older versions are kept for
+    # backward compatibility with legacy integrations.
+    module WebhooksDestinationsCreateParamsWebhookVersion
+      V1 = "v1"
+      V2 = "v2"
+      V3 = "v3"
+
+      VALUES = [V1, V2, V3].freeze
+    end
+
+    # Environment of the application that owns the destination.
+    module WebhooksDestinationsCreateResponseEnvironment
+      LIVE = "live"
+      SANDBOX = "sandbox"
+
+      VALUES = [LIVE, SANDBOX].freeze
+    end
+
+    # Delivery health. `failing`: 3 or more consecutive events failed their first delivery attempt since the
+    # destination last answered successfully (see `failing_streak`). `degraded`: not failing, but a delivery attempt
+    # failed in the last 24 hours and no later attempt has delivered that event; a retry or resend that delivers it
+    # clears this. `healthy`: neither. Independent of `enabled`. A failed attempt is one answered with HTTP 400 or
+    # above, or not answered at all.
+    module WebhooksDestinationsCreateResponseHealthStatus
+      HEALTHY = "healthy"
+      DEGRADED = "degraded"
+      FAILING = "failing"
+
+      VALUES = [HEALTHY, DEGRADED, FAILING].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module WebhooksDestinationsCreateResponseWebhookVersion
+      V1 = "v1"
+      V2 = "v2"
+      V3 = "v3"
+
+      VALUES = [V1, V2, V3].freeze
+    end
+
+    # Environment of the application that owns the destination.
+    module WebhooksDestinationsListResponseItemEnvironment
+      LIVE = "live"
+      SANDBOX = "sandbox"
+
+      VALUES = [LIVE, SANDBOX].freeze
+    end
+
+    # Delivery health. `failing`: 3 or more consecutive events failed their first delivery attempt since the
+    # destination last answered successfully (see `failing_streak`). `degraded`: not failing, but a delivery attempt
+    # failed in the last 24 hours and no later attempt has delivered that event; a retry or resend that delivers it
+    # clears this. `healthy`: neither. Independent of `enabled`. A failed attempt is one answered with HTTP 400 or
+    # above, or not answered at all.
+    module WebhooksDestinationsListResponseItemHealthStatus
+      HEALTHY = "healthy"
+      DEGRADED = "degraded"
+      FAILING = "failing"
+
+      VALUES = [HEALTHY, DEGRADED, FAILING].freeze
+    end
+
+    # Payload schema version sent to this destination. `v3` is the current/recommended format.
+    module WebhooksDestinationsListResponseItemWebhookVersion
+      V1 = "v1"
+      V2 = "v2"
+      V3 = "v3"
+
+      VALUES = [V1, V2, V3].freeze
+    end
+
+    # Environment of the application that owns the destination.
+    module WebhooksDestinationsRetrieveResponseEnvironment
+      LIVE = "live"
+      SANDBOX = "sandbox"
+
+      VALUES = [LIVE, SANDBOX].freeze
+    end
+
+    # Delivery health. `failing`: 3 or more consecutive events failed their first delivery attempt since the
+    # destination last answered successfully (see `failing_streak`). `degraded`: not failing, but a delivery attempt
+    # failed in the last 24 hours and no later attempt has delivered that event; a retry or resend that delivers it
+    # clears this. `healthy`: neither. Independent of `enabled`. A failed attempt is one answered with HTTP 400 or
+    # above, or not answered at all.
+    module WebhooksDestinationsRetrieveResponseHealthStatus
+      HEALTHY = "healthy"
+      DEGRADED = "degraded"
+      FAILING = "failing"
+
+      VALUES = [HEALTHY, DEGRADED, FAILING].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module WebhooksDestinationsRetrieveResponseWebhookVersion
+      V1 = "v1"
+      V2 = "v2"
+      V3 = "v3"
+
+      VALUES = [V1, V2, V3].freeze
+    end
+
+    # New payload schema version for future deliveries.
+    module WebhooksDestinationsUpdateParamsWebhookVersion
+      V1 = "v1"
+      V2 = "v2"
+      V3 = "v3"
+
+      VALUES = [V1, V2, V3].freeze
+    end
+
+    # Environment of the application that owns the destination.
+    module WebhooksDestinationsUpdateResponseEnvironment
+      LIVE = "live"
+      SANDBOX = "sandbox"
+
+      VALUES = [LIVE, SANDBOX].freeze
+    end
+
+    # Delivery health. `failing`: 3 or more consecutive events failed their first delivery attempt since the
+    # destination last answered successfully (see `failing_streak`). `degraded`: not failing, but a delivery attempt
+    # failed in the last 24 hours and no later attempt has delivered that event; a retry or resend that delivers it
+    # clears this. `healthy`: neither. Independent of `enabled`. A failed attempt is one answered with HTTP 400 or
+    # above, or not answered at all.
+    module WebhooksDestinationsUpdateResponseHealthStatus
+      HEALTHY = "healthy"
+      DEGRADED = "degraded"
+      FAILING = "failing"
+
+      VALUES = [HEALTHY, DEGRADED, FAILING].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module WebhooksDestinationsUpdateResponseWebhookVersion
+      V1 = "v1"
+      V2 = "v2"
+      V3 = "v3"
+
+      VALUES = [V1, V2, V3].freeze
+    end
+
+    # When the hosted flow and the native SDKs ask the person for explicit biometric consent before a face capture.
+    # `auto` (default) asks only where a trigger applies: a declared state, the person's IP, or the identity
+    # document's issuer is in Illinois, Texas or Colorado, or the person looks to be in the US without a known state.
+    # `always` asks every person whose workflow captures a face. `never` never shows the step, and you collect consent
+    # yourself before the selfie. Each change is recorded in the audit log. See [Biometric
+    # consent](https://docs.didit.me/getting-started/biometric-consent).
+    module WebhooksUpdateConfigParamsBiometricConsentMode
+      AUTO = "auto"
+      ALWAYS = "always"
+      NEVER = "never"
+
+      VALUES = [AUTO, ALWAYS, NEVER].freeze
+    end
+
+    # Legacy application setting. The verification flow does not read it.
+    module WebhooksUpdateConfigParamsCaptureMethod
+      MOBILE = "MOBILE"
+      MOBILE_AND_DESKTOP = "MOBILE_AND_DESKTOP"
+
+      VALUES = [MOBILE, MOBILE_AND_DESKTOP].freeze
+    end
+
+    # What happens to a session's face embedding when the session is deleted. `retain_until_user_deleted` needs
+    # `face_retention_days` in the same request or already set. A change applies to session deletions from then on; it
+    # creates or purges no existing biometric template.
+    module WebhooksUpdateConfigParamsFaceRetentionPolicy
+      DELETE_WITH_SESSION = "delete_with_session"
+      RETAIN_UNTIL_USER_DELETED = "retain_until_user_deleted"
+
+      VALUES = [DELETE_WITH_SESSION, RETAIN_UNTIL_USER_DELETED].freeze
+    end
+
+    # Payload version of the legacy `webhook_url`.
+    module WebhooksUpdateConfigParamsWebhookVersion
+      V1 = "v1"
+      V2 = "v2"
+      V3 = "v3"
+
+      VALUES = [V1, V2, V3].freeze
+    end
+
+    class WebhooksDestinationsCreateResponse < Didit::Model
+      field :uuid, "uuid", :string
+      field :label, "label", :string
+      field :url, "url", :string
+      field :enabled, "enabled", :boolean
+      field :webhook_version, "webhook_version", :string
+      field :secret_shared_key, "secret_shared_key", :string
+      field :secret_last4, "secret_last4", :string
+      field :previous_secret_expires_at, "previous_secret_expires_at", :datetime
+      field :subscribed_events, "subscribed_events", [:array, :string]
+      field :created_by_email, "created_by_email", :string
+      field :created_by_name, "created_by_name", :string
+      field :created_at, "created_at", :datetime
+      field :updated_at, "updated_at", :datetime
+      field :health_status, "health_status", :string
+      field :failing_streak, "failing_streak", :integer
+      field :failing_since, "failing_since", :datetime
+      field :last_success_at, "last_success_at", :datetime
+      field :environment, "environment", :string
+      field :summary, "summary", "WebhooksDestinationsCreateResponseSummary"
+    end
+
+    # Delivery metrics for the last `metrics_window_days` (30) days. `last_delivery_at` is the most recent attempt,
+    # whenever it was made.
+    class WebhooksDestinationsCreateResponseSummary < Didit::Model
+      field :total_deliveries, "total_deliveries", :integer
+      field :failed_deliveries, "failed_deliveries", :integer
+      field :error_rate_percentage, "error_rate_percentage", :integer
+      field :min_response_time_ms, "min_response_time_ms", :integer
+      field :avg_response_time_ms, "avg_response_time_ms", :integer
+      field :max_response_time_ms, "max_response_time_ms", :integer
+      field :last_delivery_at, "last_delivery_at", :datetime
+      field :metrics_window_days, "metrics_window_days", :integer
+    end
+
+    class WebhooksDestinationsListDeliveriesResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :results, "results", [:array, "WebhookDestinationDelivery"]
+    end
+
+    class WebhooksDestinationsListResponseItem < Didit::Model
+      field :uuid, "uuid", :string
+      field :label, "label", :string
+      field :url, "url", :string
+      field :enabled, "enabled", :boolean
+      field :webhook_version, "webhook_version", :string
+      field :subscribed_events, "subscribed_events", [:array, :string]
+      field :subscribed_events_count, "subscribed_events_count", :integer
+      field :deliveries_count, "deliveries_count", :integer
+      field :failed_deliveries_count, "failed_deliveries_count", :integer
+      field :average_response_time_ms, "average_response_time_ms", :integer
+      field :error_rate_percentage, "error_rate_percentage", :integer
+      field :last_delivery_at, "last_delivery_at", :datetime
+      field :metrics_window_days, "metrics_window_days", :integer
+      field :health_status, "health_status", :string
+      field :failing_streak, "failing_streak", :integer
+      field :failing_since, "failing_since", :datetime
+      field :last_success_at, "last_success_at", :datetime
+      field :environment, "environment", :string
+      field :daily_points, "daily_points", [:array, "WebhooksDestinationsListResponseItemDailyPoints"]
+      field :secret_last4, "secret_last4", :string
+      field :created_by_email, "created_by_email", :string
+      field :created_by_name, "created_by_name", :string
+      field :created_at, "created_at", :datetime
+      field :updated_at, "updated_at", :datetime
+    end
+
+    class WebhooksDestinationsListResponseItemDailyPoints < Didit::Model
+      field :date, "date", :date
+      field :total_deliveries, "total_deliveries", :integer
+      field :failed_deliveries, "failed_deliveries", :integer
+    end
+
+    class WebhooksDestinationsRetrieveAnalyticsResponse < Didit::Model
+      field :summary, "summary", "WebhooksDestinationsRetrieveAnalyticsResponseSummary"
+      field :points, "points", [:array, "WebhooksDestinationsRetrieveAnalyticsResponsePoints"]
+    end
+
+    class WebhooksDestinationsRetrieveAnalyticsResponsePoints < Didit::Model
+      field :date, "date", :date
+      field :total_deliveries, "total_deliveries", :integer
+      field :failed_deliveries, "failed_deliveries", :integer
+      field :min_response_time_ms, "min_response_time_ms", :integer
+      field :avg_response_time_ms, "avg_response_time_ms", :integer
+      field :max_response_time_ms, "max_response_time_ms", :integer
+    end
+
+    # Totals over the requested range.
+    class WebhooksDestinationsRetrieveAnalyticsResponseSummary < Didit::Model
+      field :total_deliveries, "total_deliveries", :integer
+      field :failed_deliveries, "failed_deliveries", :integer
+      field :min_response_time_ms, "min_response_time_ms", :integer
+      field :avg_response_time_ms, "avg_response_time_ms", :integer
+      field :max_response_time_ms, "max_response_time_ms", :integer
+      field :error_rate_percentage, "error_rate_percentage", :integer
+    end
+
+    class WebhooksDestinationsRetrieveResponse < Didit::Model
+      field :uuid, "uuid", :string
+      field :label, "label", :string
+      field :url, "url", :string
+      field :enabled, "enabled", :boolean
+      field :webhook_version, "webhook_version", :string
+      field :secret_shared_key, "secret_shared_key", :string
+      field :secret_last4, "secret_last4", :string
+      field :previous_secret_expires_at, "previous_secret_expires_at", :datetime
+      field :subscribed_events, "subscribed_events", [:array, :string]
+      field :created_by_email, "created_by_email", :string
+      field :created_by_name, "created_by_name", :string
+      field :created_at, "created_at", :datetime
+      field :updated_at, "updated_at", :datetime
+      field :health_status, "health_status", :string
+      field :failing_streak, "failing_streak", :integer
+      field :failing_since, "failing_since", :datetime
+      field :last_success_at, "last_success_at", :datetime
+      field :environment, "environment", :string
+      field :summary, "summary", "WebhooksDestinationsRetrieveResponseSummary"
+    end
+
+    # Delivery metrics for the last `metrics_window_days` (30) days. `last_delivery_at` is the most recent attempt,
+    # whenever it was made.
+    class WebhooksDestinationsRetrieveResponseSummary < Didit::Model
+      field :total_deliveries, "total_deliveries", :integer
+      field :failed_deliveries, "failed_deliveries", :integer
+      field :error_rate_percentage, "error_rate_percentage", :integer
+      field :min_response_time_ms, "min_response_time_ms", :integer
+      field :avg_response_time_ms, "avg_response_time_ms", :integer
+      field :max_response_time_ms, "max_response_time_ms", :integer
+      field :last_delivery_at, "last_delivery_at", :datetime
+      field :metrics_window_days, "metrics_window_days", :integer
+    end
+
+    class WebhooksDestinationsUpdateResponse < Didit::Model
+      field :uuid, "uuid", :string
+      field :label, "label", :string
+      field :url, "url", :string
+      field :enabled, "enabled", :boolean
+      field :webhook_version, "webhook_version", :string
+      field :secret_shared_key, "secret_shared_key", :string
+      field :secret_last4, "secret_last4", :string
+      field :previous_secret_expires_at, "previous_secret_expires_at", :datetime
+      field :subscribed_events, "subscribed_events", [:array, :string]
+      field :created_by_email, "created_by_email", :string
+      field :created_by_name, "created_by_name", :string
+      field :created_at, "created_at", :datetime
+      field :updated_at, "updated_at", :datetime
+      field :health_status, "health_status", :string
+      field :failing_streak, "failing_streak", :integer
+      field :failing_since, "failing_since", :datetime
+      field :last_success_at, "last_success_at", :datetime
+      field :environment, "environment", :string
+      field :summary, "summary", "WebhooksDestinationsUpdateResponseSummary"
+    end
+
+    # Delivery metrics for the last `metrics_window_days` (30) days. `last_delivery_at` is the most recent attempt,
+    # whenever it was made.
+    class WebhooksDestinationsUpdateResponseSummary < Didit::Model
+      field :total_deliveries, "total_deliveries", :integer
+      field :failed_deliveries, "failed_deliveries", :integer
+      field :error_rate_percentage, "error_rate_percentage", :integer
+      field :min_response_time_ms, "min_response_time_ms", :integer
+      field :avg_response_time_ms, "avg_response_time_ms", :integer
+      field :max_response_time_ms, "max_response_time_ms", :integer
+      field :last_delivery_at, "last_delivery_at", :datetime
+      field :metrics_window_days, "metrics_window_days", :integer
+    end
+  end
+end

data/lib/didit/types/workflows.rb

@@ -0,0 +1,32 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Omit this field to create a published workflow ready for sessions. Use `draft` only when you want to save
+    # without publishing.
+    module WorkflowsCreateParamsStatus
+      DRAFT = "draft"
+      PUBLISHED = "published"
+
+      VALUES = [DRAFT, PUBLISHED].freeze
+    end
+
+    # Controls versioning. Omit to update the current version in place (drafts auto-publish). `published` on an
+    # already-published version creates and returns a NEW version. `draft` is only valid while the version is still a
+    # draft.
+    module WorkflowsUpdateParamsStatus
+      DRAFT = "draft"
+      PUBLISHED = "published"
+
+      VALUES = [DRAFT, PUBLISHED].freeze
+    end
+
+    class WorkflowsListResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :results, "results", [:array, "WorkflowListItem"]
+    end
+  end
+end