didit-sdk 1.0.0

data/lib/didit/resources/regulatory_reports.rb

@@ -0,0 +1,314 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Resources
+    # The +regulatory_reports+ resource.
+    class RegulatoryReports < Didit::Resource
+      # Create standalone report
+      #
+      # Create a draft FIU report from the standalone Reports page: both case and template are required (unlike the
+      # case-scoped create, which can omit template).
+      #
+      # +POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/+
+      #
+      # @param case [String]
+      # @param template [String]
+      # @param report_type [String] Required unless a template is given; the template's report_type is used otherwise.
+      # @param jurisdiction [String] Required unless a template is given.
+      # @param transactions [Array<String>, nil] Transactions to attach; defaults to the case's linked transactions.
+      # @param rentity_id [String, nil]
+      # @param rentity_branch [String, nil]
+      # @param submission_code [String]
+      # @param entity_reference [String, nil]
+      # @param fiu_ref_number [String, nil]
+      # @param currency_code_local [String, nil]
+      # @param submission_date [Time, String, nil]
+      # @param reporting_person [Hash]
+      # @param location [Hash]
+      # @param reason [String, nil]
+      # @param action [String, nil]
+      # @param activity [String, nil]
+      # @param narrative [Hash]
+      # @param report_indicators [Array<String>]
+      # @param included_fields [Array<String>]
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::RegulatoryReportDetail]
+      def create(
+        case:,
+        template:,
+        report_type: OMIT,
+        jurisdiction: OMIT,
+        transactions: OMIT,
+        rentity_id: OMIT,
+        rentity_branch: OMIT,
+        submission_code: OMIT,
+        entity_reference: OMIT,
+        fiu_ref_number: OMIT,
+        currency_code_local: OMIT,
+        submission_date: OMIT,
+        reporting_person: OMIT,
+        location: OMIT,
+        reason: OMIT,
+        action: OMIT,
+        activity: OMIT,
+        narrative: OMIT,
+        report_indicators: OMIT,
+        included_fields: OMIT,
+        request_options: nil
+      )
+        @client.request(
+          :post,
+          "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/",
+          body: {
+            "case" => binding.local_variable_get(:case),
+            "template" => template,
+            "report_type" => report_type,
+            "jurisdiction" => jurisdiction,
+            "transactions" => transactions,
+            "rentity_id" => rentity_id,
+            "rentity_branch" => rentity_branch,
+            "submission_code" => submission_code,
+            "entity_reference" => entity_reference,
+            "fiu_ref_number" => fiu_ref_number,
+            "currency_code_local" => currency_code_local,
+            "submission_date" => submission_date,
+            "reporting_person" => reporting_person,
+            "location" => location,
+            "reason" => reason,
+            "action" => action,
+            "activity" => activity,
+            "narrative" => narrative,
+            "report_indicators" => report_indicators,
+            "included_fields" => included_fields
+          },
+          scope: :application,
+          response: Types::RegulatoryReportDetail,
+          request_options: request_options
+        )
+      end
+
+      # Delete report
+      #
+      # Delete a regulatory report permanently. The report, its copied narrative and reasons, its transaction links,
+      # and its generated goAML XML and PDF are erased, including every stored version of those files. The report
+      # disappears from lists and download URLs stop working. Other records, including the case, transactions, people
+      # and companies, are not deleted. There is no undo.
+      #
+      # A draft or validated report can be deleted without a request body. Deleting a finalized report requires
+      # `confirm_delete: true` in the request body. If the report is missing, the request returns `404`; if a
+      # finalized report is sent without confirmation, it returns `400` and nothing is deleted.
+      #
+      # +DELETE /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/+
+      #
+      # @param report_uuid [String] Report UUID.
+      # @param confirm_delete [Boolean] Set to true to confirm that a finalized report and its generated files are
+      #   deleted permanently.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [nil]
+      def delete(report_uuid, confirm_delete: OMIT, request_options: nil)
+        @client.request(
+          :delete,
+          "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/",
+          path_params: { "report_uuid" => report_uuid },
+          body: {
+            "confirm_delete" => confirm_delete
+          },
+          scope: :application,
+          request_options: request_options
+        )
+      end
+
+      # Finalize report
+      #
+      # Re-validate, then render the goAML XML and PDF and upload both to S3. On SAR/STR/TFR reports, this also moves
+      # the case's transaction alerts from Pending SAR to SAR filed.
+      #
+      # +POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/finalize/+
+      #
+      # @param report_uuid [String] Report UUID.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::RegulatoryReportDetail]
+      def finalize(report_uuid, request_options: nil)
+        @client.request(
+          :post,
+          "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/finalize/",
+          path_params: { "report_uuid" => report_uuid },
+          scope: :application,
+          response: Types::RegulatoryReportDetail,
+          request_options: request_options
+        )
+      end
+
+      # List reports
+      #
+      # Application-wide FIU report list, optionally filtered by status, report_type, or case.
+      #
+      # +GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/+
+      #
+      # @param limit [Integer] Page size.
+      # @param offset [Integer] Zero-based offset.
+      # @param status [String] Filter by status.
+      # @param report_type [String] Filter by report type.
+      # @param case [String] Filter to reports on this case.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Page<Didit::Types::RegulatoryReportDetail>]
+      def list(limit: OMIT, offset: OMIT, status: OMIT, report_type: OMIT, case: OMIT, request_options: nil)
+        @client.request(
+          :get,
+          "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/",
+          query: {
+            "limit" => limit,
+            "offset" => offset,
+            "status" => status,
+            "report_type" => report_type,
+            "case" => binding.local_variable_get(:case)
+          },
+          scope: :application,
+          page: Types::RegulatoryReportDetail,
+          request_options: request_options
+        )
+      end
+
+      # Get report
+      #
+      # Retrieve a regulatory report.
+      #
+      # +GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/+
+      #
+      # @param report_uuid [String] Report UUID.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::RegulatoryReportDetail]
+      def retrieve(report_uuid, request_options: nil)
+        @client.request(
+          :get,
+          "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/",
+          path_params: { "report_uuid" => report_uuid },
+          scope: :application,
+          response: Types::RegulatoryReportDetail,
+          request_options: request_options
+        )
+      end
+
+      # Get report download URL
+      #
+      # Mint a presigned URL for a finalized report's goAML XML or PDF.
+      #
+      # +GET /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/download-url/+
+      #
+      # @param report_uuid [String] Report UUID.
+      # @param file [String] Which file to download.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::RegulatoryReportsRetrieveDownloadUrlResponse]
+      def retrieve_download_url(report_uuid, file: OMIT, request_options: nil)
+        @client.request(
+          :get,
+          "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/download-url/",
+          path_params: { "report_uuid" => report_uuid },
+          query: {
+            "file" => file
+          },
+          scope: :application,
+          response: Types::RegulatoryReportsRetrieveDownloadUrlResponse,
+          request_options: request_options
+        )
+      end
+
+      # Update report
+      #
+      # Edit a draft or validated report's fields. Finalized reports cannot be edited (409).
+      #
+      # +PATCH /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/+
+      #
+      # @param report_uuid [String] Report UUID.
+      # @param jurisdiction [String]
+      # @param rentity_id [String, nil]
+      # @param rentity_branch [String, nil]
+      # @param submission_code [String]
+      # @param entity_reference [String, nil]
+      # @param fiu_ref_number [String, nil]
+      # @param currency_code_local [String, nil]
+      # @param submission_date [Time, String, nil]
+      # @param reporting_person [Hash]
+      # @param location [Hash]
+      # @param reason [String, nil]
+      # @param action [String, nil]
+      # @param activity [String, nil]
+      # @param narrative [Hash]
+      # @param report_indicators [Array<String>]
+      # @param included_fields [Array<String>]
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::RegulatoryReportDetail]
+      def update(
+        report_uuid,
+        jurisdiction: OMIT,
+        rentity_id: OMIT,
+        rentity_branch: OMIT,
+        submission_code: OMIT,
+        entity_reference: OMIT,
+        fiu_ref_number: OMIT,
+        currency_code_local: OMIT,
+        submission_date: OMIT,
+        reporting_person: OMIT,
+        location: OMIT,
+        reason: OMIT,
+        action: OMIT,
+        activity: OMIT,
+        narrative: OMIT,
+        report_indicators: OMIT,
+        included_fields: OMIT,
+        request_options: nil
+      )
+        @client.request(
+          :patch,
+          "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/",
+          path_params: { "report_uuid" => report_uuid },
+          body: {
+            "jurisdiction" => jurisdiction,
+            "rentity_id" => rentity_id,
+            "rentity_branch" => rentity_branch,
+            "submission_code" => submission_code,
+            "entity_reference" => entity_reference,
+            "fiu_ref_number" => fiu_ref_number,
+            "currency_code_local" => currency_code_local,
+            "submission_date" => submission_date,
+            "reporting_person" => reporting_person,
+            "location" => location,
+            "reason" => reason,
+            "action" => action,
+            "activity" => activity,
+            "narrative" => narrative,
+            "report_indicators" => report_indicators,
+            "included_fields" => included_fields
+          },
+          scope: :application,
+          response: Types::RegulatoryReportDetail,
+          request_options: request_options
+        )
+      end
+
+      # Validate report
+      #
+      # Check the report against the obligatory goAML header fields (reporting entity ID, submission code, local
+      # currency, action taken, submission date), plus at least one attached transaction and a 2-letter jurisdiction,
+      # without generating any files. Also stores the result on the report: validation_errors and validated_at are
+      # updated, and a non-finalized report's status moves to VALIDATED (no errors) or back to DRAFT (errors).
+      #
+      # +POST /v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/validate/+
+      #
+      # @param report_uuid [String] Report UUID.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::RegulatoryReportsValidateResponse]
+      def validate(report_uuid, request_options: nil)
+        @client.request(
+          :post,
+          "/v3/organization/{organization_id}/application/{application_id}/regulatory-reports/{report_uuid}/validate/",
+          path_params: { "report_uuid" => report_uuid },
+          scope: :application,
+          response: Types::RegulatoryReportsValidateResponse,
+          request_options: request_options
+        )
+      end
+    end
+  end
+end

data/lib/didit/resources/report_templates.rb

@@ -0,0 +1,146 @@
+# Code generated by codegen from openapi/*.json. DO NOT EDIT.
+# frozen_string_literal: true
+
+module Didit
+  module Resources
+    # The +report_templates+ resource.
+    class ReportTemplates < Didit::Resource
+      # Create report template
+      #
+      # Create a reusable per-jurisdiction, per-report-type goAML header template. Rejected with 400 if any of the
+      # template-level obligatory fields (rentity_id, submission_code, currency_code_local) is missing from
+      # field_config; an invalid template cannot be saved or used to create a report. Per-filing header fields
+      # (action, submission_date, transactions) are enforced at report validate/finalize time instead.
+      #
+      # +POST /v3/organization/{organization_id}/application/{application_id}/report-templates/+
+      #
+      # @param name [String]
+      # @param jurisdiction [String] ISO 3166-1 alpha-2 country code, upper-cased on save.
+      # @param report_type [String]
+      # @param field_config [Hash] Reusable goAML header defaults. Template-level obligatory fields: rentity_id,
+      #   submission_code, and currency_code_local (3-letter). Optional: enabled_fields (which optional report blocks to
+      #   include) plus reporting_person, location, reason, and action defaults. Per-filing header fields (action,
+      #   submission_date, transactions, jurisdiction) are enforced when the report is validated or finalized, not...
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::ReportTemplateDetail]
+      def create(name:, jurisdiction:, report_type:, field_config: OMIT, request_options: nil)
+        @client.request(
+          :post,
+          "/v3/organization/{organization_id}/application/{application_id}/report-templates/",
+          body: {
+            "name" => name,
+            "jurisdiction" => jurisdiction,
+            "report_type" => report_type,
+            "field_config" => field_config
+          },
+          scope: :application,
+          response: Types::ReportTemplateDetail,
+          request_options: request_options
+        )
+      end
+
+      # Delete report template
+      #
+      # Delete a report template. Reports already created from it are unaffected.
+      #
+      # +DELETE /v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/+
+      #
+      # @param template_uuid [String] Report template UUID.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [nil]
+      def delete(template_uuid, request_options: nil)
+        @client.request(
+          :delete,
+          "/v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/",
+          path_params: { "template_uuid" => template_uuid },
+          scope: :application,
+          request_options: request_options
+        )
+      end
+
+      # List report templates
+      #
+      # List FIU report templates for the application.
+      #
+      # +GET /v3/organization/{organization_id}/application/{application_id}/report-templates/+
+      #
+      # @param limit [Integer] Page size.
+      # @param offset [Integer] Zero-based offset.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Page<Didit::Types::ReportTemplateDetail>]
+      def list(limit: OMIT, offset: OMIT, request_options: nil)
+        @client.request(
+          :get,
+          "/v3/organization/{organization_id}/application/{application_id}/report-templates/",
+          query: {
+            "limit" => limit,
+            "offset" => offset
+          },
+          scope: :application,
+          page: Types::ReportTemplateDetail,
+          request_options: request_options
+        )
+      end
+
+      # Get report template
+      #
+      # Retrieve a report template.
+      #
+      # +GET /v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/+
+      #
+      # @param template_uuid [String] Report template UUID.
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::ReportTemplateDetail]
+      def retrieve(template_uuid, request_options: nil)
+        @client.request(
+          :get,
+          "/v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/",
+          path_params: { "template_uuid" => template_uuid },
+          scope: :application,
+          response: Types::ReportTemplateDetail,
+          request_options: request_options
+        )
+      end
+
+      # Update report template
+      #
+      # Partially update a report template. Re-validates obligatory goAML fields on save.
+      #
+      # +PATCH /v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/+
+      #
+      # @param template_uuid [String] Report template UUID.
+      # @param name [String]
+      # @param jurisdiction [String] ISO 3166-1 alpha-2 country code, upper-cased on save.
+      # @param report_type [String]
+      # @param field_config [Hash] Reusable goAML header defaults. Template-level obligatory fields: rentity_id,
+      #   submission_code, and currency_code_local (3-letter). Optional: enabled_fields (which optional report blocks to
+      #   include) plus reporting_person, location, reason, and action defaults. Per-filing header fields (action,
+      #   submission_date, transactions, jurisdiction) are enforced when the report is validated or finalized, not...
+      # @param request_options [Hash, nil] :timeout, :max_retries, :extra_headers, :extra_query, :extra_body
+      # @return [Didit::Types::ReportTemplateDetail]
+      def update(
+        template_uuid,
+        name: OMIT,
+        jurisdiction: OMIT,
+        report_type: OMIT,
+        field_config: OMIT,
+        request_options: nil
+      )
+        @client.request(
+          :patch,
+          "/v3/organization/{organization_id}/application/{application_id}/report-templates/{template_uuid}/",
+          path_params: { "template_uuid" => template_uuid },
+          body: {
+            "name" => name,
+            "jurisdiction" => jurisdiction,
+            "report_type" => report_type,
+            "field_config" => field_config
+          },
+          scope: :application,
+          response: Types::ReportTemplateDetail,
+          request_options: request_options
+        )
+      end
+    end
+  end
+end