didit-sdk 1.0.0

data/sig/didit/types/cases.rbs

@@ -0,0 +1,414 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+
+module Didit
+  module Types
+    module CasesBlueprintsCreateParamsAssignmentMethod
+      MANUAL: String
+      AUTOMATIC: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesBlueprintsListPresetsResponseResultsPresetKey
+      SCREENING_HIT: String
+      AML_INVESTIGATION: String
+      SUSPICIOUS_ACTIVITY: String
+      KYC: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesBlueprintsUpdateParamsAssignmentMethod
+      MANUAL: String
+      AUTOMATIC: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesBulkUpdateStatusParamsResolution
+      FALSE_POSITIVE: String
+      VALID_THREAT: String
+      INCONCLUSIVE: String
+      REQUIREMENTS_NOT_MET: String
+      REQUIREMENTS_SATISFIED: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesBulkUpdateStatusParamsStatus
+      OPEN: String
+      AWAITING_USER: String
+      RESOLVED: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesCreateParamsPriority
+      LOW: String
+      MEDIUM: String
+      HIGH: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesCreateParamsSubjectType
+      USER: String
+      BUSINESS: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesLinksCreateParamsEntityType
+      SESSION: String
+      BUSINESS_SESSION: String
+      TRANSACTION: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesListParamsOrdering
+      CREATED_AT: String
+      CREATED_AT_: String
+      DUE_AT: String
+      DUE_AT_: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesRegulatoryReportsCreateParamsReportType
+      SAR: String
+      STR: String
+      CTR: String
+      TTR: String
+      UTR: String
+      IFT: String
+      CBR: String
+      TFR: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesRegulatoryReportsCreateParamsSubmissionCode
+      E: String
+      M: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesRequestsRemindResponseDeliveryStatus
+      SENT: String
+      SIMULATED: String
+      UNKNOWN: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesResolveParamsResolution
+      FALSE_POSITIVE: String
+      VALID_THREAT: String
+      INCONCLUSIVE: String
+      REQUIREMENTS_NOT_MET: String
+      REQUIREMENTS_SATISFIED: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesRetrieveStatisticsParamsPriority
+      LOW: String
+      MEDIUM: String
+      HIGH: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesRetrieveStatisticsParamsSource
+      MANUAL: String
+      AML_SCREENING: String
+      TRANSACTION_RULE: String
+      WORKFLOW_BUILDER: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesRetrieveStatisticsParamsStatus
+      OPEN: String
+      AWAITING_USER: String
+      RESOLVED: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesRoutingRulesPreviewParamsPriority
+      LOW: String
+      MEDIUM: String
+      HIGH: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesRoutingRulesPreviewParamsSource
+      MANUAL: String
+      AML_SCREENING: String
+      TRANSACTION_RULE: String
+      WORKFLOW_BUILDER: String
+
+      VALUES: Array[String]
+    end
+
+    module CasesUpdateParamsPriority
+      LOW: String
+      MEDIUM: String
+      HIGH: String
+
+      VALUES: Array[String]
+    end
+
+    class CasesBlueprintsListPresetsResponse < Didit::Model
+      def results: () -> Array[Didit::Types::CasesBlueprintsListPresetsResponseResults]?
+    end
+
+    class CasesBlueprintsListPresetsResponseResults < Didit::Model
+      def preset_key: () -> String?
+      def name: () -> String?
+      def description: () -> String?
+      def content_config: () -> Didit::Types::CaseContentConfig?
+      def installed: () -> bool?
+    end
+
+    class CasesBlueprintsListResponse < Didit::Model
+      def count: () -> Integer?
+      def `next`: () -> String?
+      def previous: () -> String?
+      def results: () -> Array[Didit::Types::CaseBlueprintListItem]?
+    end
+
+    class CasesListEventsResponse < Didit::Model
+      def count: () -> Integer?
+      def `next`: () -> String?
+      def previous: () -> String?
+      def results: () -> Array[Didit::Types::CaseEvent]?
+    end
+
+    class CasesListResponse < Didit::Model
+      def count: () -> Integer?
+      def `next`: () -> String?
+      def previous: () -> String?
+      def results: () -> Array[Didit::Types::CaseListItem]?
+    end
+
+    class CasesListReviewersResponse < Didit::Model
+      def results: () -> Array[Didit::Types::CasesListReviewersResponseResults]?
+    end
+
+    class CasesListReviewersResponseResults < Didit::Model
+      def user_id: () -> String?
+      def email: () -> String?
+      def name: () -> String?
+    end
+
+    class CasesNotesCreateAttachmentUploadResponse < Didit::Model
+      def s3_key: () -> String?
+      def url: () -> String?
+      def filename: () -> String?
+      def file_size: () -> Integer?
+    end
+
+    class CasesNotesRetrieveAttachmentUrlResponse < Didit::Model
+      def s3_key: () -> String?
+      def url: () -> String?
+      def filename: () -> String?
+    end
+
+    class CasesPrintResponse < Didit::Model
+      def url: () -> String?
+    end
+
+    class CasesRequestsRemindResponse < Didit::Model
+      def request: () -> Didit::Types::CustomerMessagingCaseRequest
+      def reminded_at: () -> Time
+      def delivery_status: () -> String
+      def next_reminder_at: () -> Time
+    end
+
+    class CasesRetrieveStatisticsResponse < Didit::Model
+      def series: () -> Array[Didit::Types::CasesRetrieveStatisticsResponseSeries]?
+      def tables: () -> Didit::Types::CasesRetrieveStatisticsResponseTables?
+      def totals: () -> Didit::Types::CasesRetrieveStatisticsResponseTotals?
+      def queue: () -> Didit::Types::CasesRetrieveStatisticsResponseQueue?
+    end
+
+    class CasesRetrieveStatisticsResponseQueue < Didit::Model
+      def open: () -> Integer?
+      def overdue: () -> Integer?
+    end
+
+    class CasesRetrieveStatisticsResponseSeries < Didit::Model
+      def date: () -> Date?
+      def created: () -> Integer?
+      def reviewed: () -> Integer?
+    end
+
+    class CasesRetrieveStatisticsResponseTables < Didit::Model
+      def officer: () -> Array[Didit::Types::CasesRetrieveStatisticsResponseTablesOfficer]?
+      def blueprint: () -> Array[Didit::Types::CasesRetrieveStatisticsResponseTablesBlueprint]?
+      def source: () -> Array[Didit::Types::CasesRetrieveStatisticsResponseTablesSource]?
+      def status: () -> Array[Didit::Types::CasesRetrieveStatisticsResponseTablesStatus]?
+    end
+
+    class CasesRetrieveStatisticsResponseTablesBlueprint < Didit::Model
+      def key: () -> String?
+      def created: () -> Integer?
+      def assigned: () -> Integer?
+      def resolved: () -> Integer?
+      def threat_rate: () -> Float?
+      def false_positive_rate: () -> Float?
+      def unresolved: () -> Integer?
+      def reassignment_rate: () -> Float?
+      def escalation_rate: () -> Float?
+      def avg_assign_hours: () -> Float?
+      def avg_resolve_hours: () -> Float?
+      def avg_handling_hours: () -> Float?
+    end
+
+    class CasesRetrieveStatisticsResponseTablesOfficer < Didit::Model
+      def key: () -> String?
+      def created: () -> Integer?
+      def assigned: () -> Integer?
+      def resolved: () -> Integer?
+      def threat_rate: () -> Float?
+      def false_positive_rate: () -> Float?
+      def unresolved: () -> Integer?
+      def reassignment_rate: () -> Float?
+      def escalation_rate: () -> Float?
+      def avg_assign_hours: () -> Float?
+      def avg_resolve_hours: () -> Float?
+      def avg_handling_hours: () -> Float?
+    end
+
+    class CasesRetrieveStatisticsResponseTablesSource < Didit::Model
+      def key: () -> String?
+      def created: () -> Integer?
+      def assigned: () -> Integer?
+      def resolved: () -> Integer?
+      def threat_rate: () -> Float?
+      def false_positive_rate: () -> Float?
+      def unresolved: () -> Integer?
+      def reassignment_rate: () -> Float?
+      def escalation_rate: () -> Float?
+      def avg_assign_hours: () -> Float?
+      def avg_resolve_hours: () -> Float?
+      def avg_handling_hours: () -> Float?
+    end
+
+    class CasesRetrieveStatisticsResponseTablesStatus < Didit::Model
+      def key: () -> String?
+      def created: () -> Integer?
+      def assigned: () -> Integer?
+      def resolved: () -> Integer?
+      def threat_rate: () -> Float?
+      def false_positive_rate: () -> Float?
+      def unresolved: () -> Integer?
+      def reassignment_rate: () -> Float?
+      def escalation_rate: () -> Float?
+      def avg_assign_hours: () -> Float?
+      def avg_resolve_hours: () -> Float?
+      def avg_handling_hours: () -> Float?
+    end
+
+    class CasesRetrieveStatisticsResponseTotals < Didit::Model
+      def created: () -> Integer?
+      def assigned: () -> Integer?
+      def resolved: () -> Integer?
+      def threat_rate: () -> Float?
+      def false_positive_rate: () -> Float?
+      def unresolved: () -> Integer?
+      def reassignment_rate: () -> Float?
+      def escalation_rate: () -> Float?
+      def avg_assign_hours: () -> Float?
+      def avg_resolve_hours: () -> Float?
+      def avg_handling_hours: () -> Float?
+    end
+
+    class CasesRoutingRulesListResponse < Didit::Model
+      def results: () -> Array[Didit::Types::CaseRoutingRule]?
+      def count: () -> Integer?
+      def `next`: () -> String?
+      def previous: () -> String?
+    end
+
+    class CasesTeamsListResponse < Didit::Model
+      def results: () -> Array[Didit::Types::CaseReviewTeam]?
+      def count: () -> Integer?
+      def `next`: () -> String?
+      def previous: () -> String?
+    end
+
+    type cases_apply_entity_action_params = { ?client_reference: String, ?retry: bool, action: String, ?status: String?, ?tags: Array[String], ?note: String? }
+
+    type cases_assign_params = { assignee_user_id: String?, ?assignee_email: String?, ?assignee_name: String? }
+
+    type cases_blueprints_create_params = { name: String, ?description: String?, assignee_pool: Array[String], ?assignment_method: String, ?max_active_cases: Integer?, ?escalation_enabled: bool, ?escalation_blueprint: String?, ?transfer_enabled: bool, ?four_eyes_checker_blueprint: String?, ?require_resolution_note: bool, ?content_config: Didit::Types::case_content_config, ?is_active: bool, ?default_deadline_hours: Integer?, ?publish: bool }
+
+    type cases_blueprints_discard_draft_params = { expected_version: Integer, expected_revision: String? }
+
+    type cases_blueprints_install_presets_params = { ?preset_keys: Array[String]? }
+
+    type cases_blueprints_publish_params = { expected_version: Integer, expected_revision: String? }
+
+    type cases_blueprints_save_draft_params = { expected_version: Integer, expected_revision: String?, changes: Hash[String | Symbol, untyped] }
+
+    type cases_blueprints_update_params = { ?name: String, ?description: String?, ?assignee_pool: Array[String], ?assignment_method: String, ?max_active_cases: Integer?, ?escalation_enabled: bool, ?escalation_blueprint: String?, ?transfer_enabled: bool, ?four_eyes_checker_blueprint: String?, ?require_resolution_note: bool, ?content_config: Didit::Types::case_content_config, ?is_active: bool, ?default_deadline_hours: Integer?, ?expected_version: Integer }
+
+    type cases_bulk_assign_params = { case_uuids: Array[String], assignee_user_id: String?, ?assignee_email: String?, ?assignee_name: String? }
+
+    type cases_bulk_update_status_params = { case_uuids: Array[String], status: String, ?resolution: String, ?note: String? }
+
+    type cases_checklist_toggle_item_params = { is_completed: bool }
+
+    type cases_create_params = { title: String, ?blueprint: String?, ?priority: String, ?due_at: (Time | String)?, ?tags: Array[String], ?subject: Didit::Types::cases_create_params_subject, ?links: Array[Hash[String | Symbol, untyped]], ?assigned_to: String?, ?review_duplicates: bool, ?separate_incident_reason: String, ?source_context: Didit::Types::case_duplicate_case_fraud_source_context_request }
+
+    type cases_create_params_subject = { ?type: String, ?uuid: String }
+
+    type cases_find_duplicates_params = { ?subject: Didit::Types::case_duplicate_case_subject_input_request, ?links: Array[Didit::Types::case_duplicate_case_link_create_request], ?offset: Integer }
+
+    type cases_links_create_params = { entity_type: String, entity_uuid: String }
+
+    type cases_notes_create_attachment_upload_params = { file: Didit::upload }
+
+    type cases_notes_create_params = { comment: String, ?reply_to: String?, ?client_reference: String?, ?mentioned_emails: Array[String], ?is_internal: bool, ?attachments: Array[Hash[String | Symbol, untyped]], ?tags: Array[String] }
+
+    type cases_notes_update_params = { ?is_pinned: bool }
+
+    type cases_regulatory_reports_create_params = { ?report_type: String, ?jurisdiction: String, ?template: String?, ?transactions: Array[String]?, ?rentity_id: String?, ?rentity_branch: String?, ?submission_code: String, ?entity_reference: String?, ?fiu_ref_number: String?, ?currency_code_local: String?, ?submission_date: (Time | String)?, ?reporting_person: Hash[String | Symbol, untyped], ?location: Hash[String | Symbol, untyped], ?reason: String?, ?action: String?, ?activity: String?, ?narrative: Didit::Types::cases_regulatory_reports_create_params_narrative, ?report_indicators: Array[String], ?included_fields: Array[String] }
+
+    type cases_regulatory_reports_create_params_narrative = { ?who: String, ?what: String, ?when: String, ?where: String, ?why: String, ?how: String }
+
+    type cases_reject_resolution_params = { ?notes: String? }
+
+    type cases_requests_create_params = { contact_id: String, purpose: String, ?language: String, request_id: String, expires_at: Time | String, preview_token: String }
+
+    type cases_requests_preview_params = { contact_id: String, purpose: String, ?language: String }
+
+    type cases_resolve_params = { resolution: String, ?note: String?, ?checker: String? }
+
+    type cases_routing_rules_create_params = { name: String, ?description: String, ?priority: Integer, conditions: Array[Didit::Types::case_routing_condition], ?required_skills: Array[String], blueprint: String, ?team: String?, ?is_active: bool, ?publish: bool }
+
+    type cases_routing_rules_discard_draft_params = { expected_version: Integer, expected_revision: String? }
+
+    type cases_routing_rules_preview_params = { source: String, ?priority: String, ?tags: Array[String], ?rule_uuid: String, ?draft: Didit::Types::case_routing_rule_create }
+
+    type cases_routing_rules_publish_params = { expected_version: Integer, expected_revision: String? }
+
+    type cases_routing_rules_save_draft_params = { expected_version: Integer, expected_revision: String?, changes: Hash[String | Symbol, untyped] }
+
+    type cases_routing_rules_update_params = { ?name: String, ?description: String, ?priority: Integer, ?conditions: Array[Didit::Types::case_routing_condition], ?required_skills: Array[String], ?blueprint: String, ?team: String?, ?is_active: bool, ?expected_version: Integer }
+
+    type cases_teams_create_params = { name: String, ?description: String, members: Array[Didit::Types::case_review_team_member], ?is_active: bool }
+
+    type cases_teams_update_params = { ?name: String, ?description: String, ?members: Array[Didit::Types::case_review_team_member], ?is_active: bool }
+
+    type cases_transfer_params = { target_blueprint: String }
+
+    type cases_update_params = { ?title: String, ?priority: String, ?due_at: (Time | String)?, ?tags: Array[String], ?team: String? }
+  end
+end