didit-sdk 1.0.0

data/lib/didit/types/proof_of_address.rb

@@ -0,0 +1,166 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # What to do when the extracted details disagree with the `expected_*` fields: `ADDRESS_MISMATCH_WITH_PROVIDED`,
+    # `NAME_MISMATCH_WITH_PROVIDED`, and `POA_COUNTRY_MISMATCH_WITH_PROVIDED` all follow this action.
+    module ProofOfAddressVerifyParamsPoaAddressMismatchAction
+      DECLINE = "DECLINE"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, NO_ACTION].freeze
+    end
+
+    # What to do when document manipulation is suspected (`SUSPECTED_DOCUMENT_MANIPULATION`) - e.g. the PDF was
+    # modified after digital signing, processed by a known PDF editor, shows overlay-text manipulation, or has
+    # inconsistent EXIF dates.
+    module ProofOfAddressVerifyParamsPoaDocumentAuthenticityAction
+      DECLINE = "DECLINE"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, NO_ACTION].freeze
+    end
+
+    # What to do on file-integrity problems - in practice only `DOCUMENT_METADATA_MISMATCH` is produced by this
+    # endpoint.
+    module ProofOfAddressVerifyParamsPoaDocumentIssuesAction
+      DECLINE = "DECLINE"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, NO_ACTION].freeze
+    end
+
+    # What to do when no issuing company/organization can be identified on the document (`ISSUER_NOT_IDENTIFIED`).
+    module ProofOfAddressVerifyParamsPoaIssuerNotIdentifiedAction
+      DECLINE = "DECLINE"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, NO_ACTION].freeze
+    end
+
+    # Accepted but **currently not applied** - name-mismatch warnings (`NAME_MISMATCH_WITH_PROVIDED`) follow
+    # `poa_address_mismatch_action` instead. Set `poa_address_mismatch_action` to control both name and address
+    # mismatch behavior.
+    module ProofOfAddressVerifyParamsPoaNameMismatchAction
+      DECLINE = "DECLINE"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, NO_ACTION].freeze
+    end
+
+    # What to do when the document language is outside `poa_languages_allowed` (`UNSUPPORTED_DOCUMENT_LANGUAGE`).
+    module ProofOfAddressVerifyParamsPoaUnsupportedLanguageAction
+      DECLINE = "DECLINE"
+      NO_ACTION = "NO_ACTION"
+
+      VALUES = [DECLINE, NO_ACTION].freeze
+    end
+
+    # Detected document category. `UNKNOWN` means the document could not be classified as an acceptable Proof of
+    # Address and auto-declines with `INVALID_DOCUMENT_TYPE`. Never null - classification failures fall back to
+    # `UNKNOWN`.
+    module ProofOfAddressVerifyResponsePoaDocumentType
+      UTILITY_BILL = "UTILITY_BILL"
+      BANK_STATEMENT = "BANK_STATEMENT"
+      GOVERNMENT_ISSUED_DOCUMENT = "GOVERNMENT_ISSUED_DOCUMENT"
+      OTHER_POA_DOCUMENT = "OTHER_POA_DOCUMENT"
+      UNKNOWN = "UNKNOWN"
+
+      VALUES = [UTILITY_BILL, BANK_STATEMENT, GOVERNMENT_ISSUED_DOCUMENT, OTHER_POA_DOCUMENT, UNKNOWN].freeze
+    end
+
+    # `Approved` when no warning resolves to a decline; `Declined` otherwise - the `warnings` list explains why.
+    module ProofOfAddressVerifyResponsePoaStatus
+      APPROVED = "Approved"
+      DECLINED = "Declined"
+
+      VALUES = [APPROVED, DECLINED].freeze
+    end
+
+    # Feature that raised the warning. Always `PROOF_OF_ADDRESS` on this endpoint.
+    module ProofOfAddressVerifyResponsePoaWarningsFeature
+      PROOF_OF_ADDRESS = "PROOF_OF_ADDRESS"
+
+      VALUES = [PROOF_OF_ADDRESS].freeze
+    end
+
+    # Severity. `error` warnings drive `status` to `Declined`; `information` entries are advisory and never decline on
+    # their own. (`warning` is not produced by this endpoint - its options only accept `DECLINE` or `NO_ACTION`.)
+    module ProofOfAddressVerifyResponsePoaWarningsLogType
+      ERROR = "error"
+      INFORMATION = "information"
+
+      VALUES = [ERROR, INFORMATION].freeze
+    end
+
+    class ProofOfAddressVerifyResponse < Didit::Model
+      field :request_id, "request_id", :string
+      field :poa, "poa", "ProofOfAddressVerifyResponsePoa"
+      field :vendor_data, "vendor_data", :string
+      field :metadata, "metadata", :any
+      field :created_at, "created_at", :datetime
+    end
+
+    class ProofOfAddressVerifyResponsePoa < Didit::Model
+      field :status, "status", :string
+      field :issuing_state, "issuing_state", :string
+      field :document_type, "document_type", :string
+      field :document_subtype, "document_subtype", :string
+      field :document_language, "document_language", :string
+      field :issuer, "issuer", :string
+      field :issue_date, "issue_date", :date
+      field :expiration_date, "expiration_date", :date
+      field :poa_address, "poa_address", :string
+      field :poa_formatted_address, "poa_formatted_address", :string
+      field :poa_parsed_address, "poa_parsed_address", "ProofOfAddressVerifyResponsePoaPoaParsedAddress"
+      field :expected_details_address, "expected_details_address", :string
+      field :expected_details_formatted_address, "expected_details_formatted_address", :string
+      field :expected_details_parsed_address, "expected_details_parsed_address", :any
+      field :name_on_document, "name_on_document", :string
+      field :extra_fields, "extra_fields", "ProofOfAddressVerifyResponsePoaExtraFields"
+      field :warnings, "warnings", [:array, "ProofOfAddressVerifyResponsePoaWarnings"]
+      field :detected_codes, "detected_codes", [:array, "DocumentAIDetectedCode"]
+    end
+
+    # Document-specific extras. Bank fields are populated for bank statements when printed on the document; `null`
+    # otherwise.
+    class ProofOfAddressVerifyResponsePoaExtraFields < Didit::Model
+      field :bank_account_number, "bank_account_number", :string
+      field :bank_iban, "bank_iban", :string
+      field :bank_sort_code, "bank_sort_code", :string
+      field :bank_routing_number, "bank_routing_number", :string
+      field :bank_swift_bic, "bank_swift_bic", :string
+      field :bank_branch_name, "bank_branch_name", :string
+      field :bank_branch_address, "bank_branch_address", :string
+      field :document_phone_number, "document_phone_number", :string
+      field :additional_names, "additional_names", [:array, :string]
+    end
+
+    # Structured, geocoded breakdown of the document address. `null` when the address could not be parsed.
+    class ProofOfAddressVerifyResponsePoaPoaParsedAddress < Didit::Model
+      field :street_1, "street_1", :string
+      field :street_2, "street_2", :string
+      field :city, "city", :string
+      field :region, "region", :string
+      field :country, "country", :string
+      field :postal_code, "postal_code", :string
+      field :document_location, "document_location", "ProofOfAddressVerifyResponsePoaPoaParsedAddressDocumentLocation"
+    end
+
+    # Geocoded coordinates of the document address.
+    class ProofOfAddressVerifyResponsePoaPoaParsedAddressDocumentLocation < Didit::Model
+      field :latitude, "latitude", :float
+      field :longitude, "longitude", :float
+    end
+
+    class ProofOfAddressVerifyResponsePoaWarnings < Didit::Model
+      field :risk, "risk", :string
+      field :feature, "feature", :string
+      field :additional_data, "additional_data", :any
+      field :log_type, "log_type", :string
+      field :short_description, "short_description", :string
+      field :long_description, "long_description", :string
+    end
+  end
+end

data/lib/didit/types/questionnaires.rb

@@ -0,0 +1,29 @@
+# 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 questionnaire ready for workflows.
+    module QuestionnairesCreateParamsStatus
+      DRAFT = "draft"
+      PUBLISHED = "published"
+
+      VALUES = [DRAFT, PUBLISHED].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module QuestionnairesUpdateParamsStatus
+      DRAFT = "draft"
+      PUBLISHED = "published"
+
+      VALUES = [DRAFT, PUBLISHED].freeze
+    end
+
+    class QuestionnairesListResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :results, "results", [:array, "QuestionnaireListItem"]
+    end
+  end
+end

data/lib/didit/types/regulatory_reports.rb

@@ -0,0 +1,100 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Required unless a template is given; the template's report_type is used otherwise.
+    module RegulatoryReportsCreateParamsReportType
+      SAR = "SAR"
+      STR = "STR"
+      CTR = "CTR"
+      TTR = "TTR"
+      UTR = "UTR"
+      IFT = "IFT"
+      CBR = "CBR"
+      TFR = "TFR"
+
+      VALUES = [SAR, STR, CTR, TTR, UTR, IFT, CBR, TFR].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module RegulatoryReportsCreateParamsSubmissionCode
+      E = "E"
+      M = "M"
+
+      VALUES = [E, M].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module RegulatoryReportsListParamsReportType
+      SAR = "SAR"
+      STR = "STR"
+      CTR = "CTR"
+      TTR = "TTR"
+      UTR = "UTR"
+      IFT = "IFT"
+      CBR = "CBR"
+      TFR = "TFR"
+
+      VALUES = [SAR, STR, CTR, TTR, UTR, IFT, CBR, TFR].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module RegulatoryReportsListParamsStatus
+      DRAFT = "DRAFT"
+      VALIDATED = "VALIDATED"
+      FINALIZED = "FINALIZED"
+
+      VALUES = [DRAFT, VALIDATED, FINALIZED].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module RegulatoryReportsRetrieveDownloadUrlParamsFile
+      PDF = "pdf"
+      XML = "xml"
+
+      VALUES = [PDF, XML].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module RegulatoryReportsRetrieveDownloadUrlResponseFile
+      PDF = "pdf"
+      XML = "xml"
+
+      VALUES = [PDF, XML].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module RegulatoryReportsUpdateParamsSubmissionCode
+      E = "E"
+      M = "M"
+
+      VALUES = [E, M].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module RegulatoryReportsValidateResponseStatus
+      DRAFT = "DRAFT"
+      VALIDATED = "VALIDATED"
+      FINALIZED = "FINALIZED"
+
+      VALUES = [DRAFT, VALIDATED, FINALIZED].freeze
+    end
+
+    class RegulatoryReportsRetrieveDownloadUrlResponse < Didit::Model
+      field :download_url, "download_url", :string
+      field :file, "file", :string
+    end
+
+    class RegulatoryReportsValidateResponse < Didit::Model
+      field :status, "status", :string
+      field :is_valid, "is_valid", :boolean
+      field :errors, "errors", [:array, "RegulatoryReportsValidateResponseErrors"]
+    end
+
+    class RegulatoryReportsValidateResponseErrors < Didit::Model
+      field :field, "field", :string
+      field :message, "message", :string
+    end
+  end
+end

data/lib/didit/types/report_templates.rb

@@ -0,0 +1,41 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Types
+    # Known values of an open enum: the API may send others.
+    module ReportTemplatesCreateParamsReportType
+      SAR = "SAR"
+      STR = "STR"
+      CTR = "CTR"
+      TTR = "TTR"
+      UTR = "UTR"
+      IFT = "IFT"
+      CBR = "CBR"
+      TFR = "TFR"
+
+      VALUES = [SAR, STR, CTR, TTR, UTR, IFT, CBR, TFR].freeze
+    end
+
+    # Known values of an open enum: the API may send others.
+    module ReportTemplatesUpdateParamsReportType
+      SAR = "SAR"
+      STR = "STR"
+      CTR = "CTR"
+      TTR = "TTR"
+      UTR = "UTR"
+      IFT = "IFT"
+      CBR = "CBR"
+      TFR = "TFR"
+
+      VALUES = [SAR, STR, CTR, TTR, UTR, IFT, CBR, TFR].freeze
+    end
+
+    class ReportTemplatesListResponse < Didit::Model
+      field :count, "count", :integer
+      field :next, "next", :string
+      field :previous, "previous", :string
+      field :results, "results", [:array, "ReportTemplateDetail"]
+    end
+  end
+end