inttegro 4.3.1 → 6.0.0

data/lib/inttegro/message_template/page_envelope.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "page"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the page envelope object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] page
+    #   Value of the `page` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `page`.
+    #   @return [Inttegro::MessageTemplate::Page]
+    class PageEnvelope < T::Struct
+      const :page, Inttegro::MessageTemplate::Page
+    end
+  end
+end

data/lib/inttegro/message_template/page_request.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "channel"
+require_relative "status"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the page request object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] page
+    #   Value of the `page` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] size
+    #   Value of the `size` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `size`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] status
+    #   Value of the `status` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `status`.
+    #   @return [Inttegro::MessageTemplate::Status, nil]
+    #
+    # @!attribute [r] channel
+    #   Value of the `channel` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `channel`.
+    #   @return [Inttegro::MessageTemplate::Channel, nil]
+    #
+    # @!attribute [r] purpose
+    #   Value of the `purpose` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `purpose`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] locale
+    #   Value of the `locale` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `locale`.
+    #   @return [String, nil]
+    class PageRequest < T::Struct
+      const :page, T.nilable(Integer), default: nil
+      const :size, T.nilable(Integer), default: nil
+      const :status, T.nilable(Inttegro::MessageTemplate::Status), default: nil
+      const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
+      const :purpose, T.nilable(String), default: nil
+      const :locale, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/message_template/preview.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "message_template"
+require_relative "rendered"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the preview object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] message_template
+    #   Value of the `message_template` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `message_template`.
+    #   @return [Inttegro::MessageTemplate]
+    #
+    # @!attribute [r] rendered
+    #   Value of the `rendered` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `rendered`.
+    #   @return [Inttegro::MessageTemplate::Rendered]
+    class Preview < T::Struct
+      const :message_template, Inttegro::MessageTemplate
+      const :rendered, Inttegro::MessageTemplate::Rendered
+    end
+  end
+end

data/lib/inttegro/message_template/reference.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "variables"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the reference object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] template_id
+    #   API-generated message template id.
+    #
+    #   Required in the API payload. Wire name: `template_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] variables
+    #   Variable values used when rendering a template.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `variables`.
+    #   @return [Inttegro::MessageTemplate::Variables, nil]
+    class Reference < T::Struct
+      const :template_id, String
+      const :variables, T.nilable(Inttegro::MessageTemplate::Variables), default: nil
+    end
+  end
+end

data/lib/inttegro/message_template/render_preview_request.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "reference"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the render preview request object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] message_template
+    #   Value of the `message_template` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `message_template`.
+    #   @return [Inttegro::MessageTemplate::Reference]
+    class RenderPreviewRequest < T::Struct
+      const :message_template, Inttegro::MessageTemplate::Reference
+    end
+  end
+end

data/lib/inttegro/message_template/rendered.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "attachment_ids"
+require_relative "channel"
+require_relative "rendered_email"
+require_relative "rendered_sms"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the rendered object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] channel
+    #   Value of the `channel` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `channel`.
+    #   @return [Inttegro::MessageTemplate::Channel]
+    #
+    # @!attribute [r] attachments
+    #   Stored file IDs returned by previews. Chime send, schedule, and broadcast currently reject
+    #   stored-template attachments.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `attachments`.
+    #   @return [Inttegro::MessageTemplate::AttachmentIDs, nil]
+    #
+    # @!attribute [r] sms
+    #   Value of the `sms` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sms`.
+    #   @return [Inttegro::MessageTemplate::RenderedSMS, nil]
+    #
+    # @!attribute [r] email
+    #   Value of the `email` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email`.
+    #   @return [Inttegro::MessageTemplate::RenderedEmail, nil]
+    class Rendered < T::Struct
+      const :channel, Inttegro::MessageTemplate::Channel
+      const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
+      const :sms, T.nilable(Inttegro::MessageTemplate::RenderedSMS), default: nil
+      const :email, T.nilable(Inttegro::MessageTemplate::RenderedEmail), default: nil
+    end
+  end
+end

data/lib/inttegro/message_template/rendered_email.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "mailbox"
+require_relative "safety_result"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the rendered email object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] subject
+    #   Value of the `subject` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `subject`.
+    #   @return [String]
+    #
+    # @!attribute [r] text
+    #   Value of the `text` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `text`.
+    #   @return [String]
+    #
+    # @!attribute [r] html
+    #   Value of the `html` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `html`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] from
+    #   Value of the `from` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `from`.
+    #   @return [Inttegro::MessageTemplate::Mailbox, nil]
+    #
+    # @!attribute [r] reply_to
+    #   Value of the `reply_to` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reply_to`.
+    #   @return [Inttegro::MessageTemplate::Mailbox, nil]
+    #
+    # @!attribute [r] headers
+    #   Validated provider-neutral email headers.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `headers`.
+    #   @return [Hash{String => String}, nil]
+    #
+    # @!attribute [r] safety
+    #   Result of the email safety scan.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `safety`.
+    #   @return [Inttegro::MessageTemplate::SafetyResult, nil]
+    class RenderedEmail < T::Struct
+      const :subject, String
+      const :text, String
+      const :html, T.nilable(String), default: nil
+      const :from, T.nilable(Inttegro::MessageTemplate::Mailbox), default: nil
+      const :reply_to, T.nilable(Inttegro::MessageTemplate::Mailbox), default: nil
+      const :headers, T.nilable(T::Hash[String, String]), default: nil
+      const :safety, T.nilable(Inttegro::MessageTemplate::SafetyResult), default: nil
+    end
+  end
+end

data/lib/inttegro/message_template/rendered_sms.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the rendered sms object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] full_message
+    #   Value of the `full_message` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `full_message`.
+    #   @return [String]
+    class RenderedSMS < T::Struct
+      const :full_message, String
+    end
+  end
+end

data/lib/inttegro/message_template/safety_result.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../shared/content_safety_status"
+require_relative "scanned_link"
+
+module Inttegro
+  class MessageTemplate
+    # Result of the email safety scan.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] content_hash
+    #   Value of the `content_hash` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `content_hash`.
+    #   @return [String]
+    #
+    # @!attribute [r] links
+    #   Value of the `links` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `links`.
+    #   @return [Array<Inttegro::MessageTemplate::ScannedLink>, nil]
+    #
+    # @!attribute [r] normalized_text
+    #   Value of the `normalized_text` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `normalized_text`.
+    #   @return [String]
+    #
+    # @!attribute [r] quarantine_notes
+    #   Value of the `quarantine_notes` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `quarantine_notes`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] reason_codes
+    #   Value of the `reason_codes` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reason_codes`.
+    #   @return [Array<String>, nil]
+    #
+    # @!attribute [r] sanitized_html
+    #   Value of the `sanitized_html` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sanitized_html`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] scanner
+    #   Value of the `scanner` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `scanner`.
+    #   @return [String]
+    #
+    # @!attribute [r] status
+    #   Value of the `status` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `status`.
+    #   @return [Inttegro::Shared::ContentSafetyStatus]
+    class SafetyResult < T::Struct
+      const :content_hash, String
+      const :links, T.nilable(T::Array[Inttegro::MessageTemplate::ScannedLink]), default: nil
+      const :normalized_text, String
+      const :quarantine_notes, T.nilable(String), default: nil
+      const :reason_codes, T.nilable(T::Array[String]), default: nil
+      const :sanitized_html, T.nilable(String), default: nil
+      const :scanner, String
+      const :status, Inttegro::Shared::ContentSafetyStatus
+    end
+  end
+end

data/lib/inttegro/message_template/scanned_link.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the scanned link object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] host
+    #   Value of the `host` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `host`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] raw
+    #   Value of the `raw` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `raw`.
+    #   @return [String]
+    #
+    # @!attribute [r] reason
+    #   Value of the `reason` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reason`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] scheme
+    #   Value of the `scheme` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `scheme`.
+    #   @return [String]
+    #
+    # @!attribute [r] status
+    #   Value of the `status` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `status`.
+    #   @return [String]
+    class ScannedLink < T::Struct
+      const :host, T.nilable(String), default: nil
+      const :raw, String
+      const :reason, T.nilable(String), default: nil
+      const :scheme, String
+      const :status, String
+    end
+  end
+end

data/lib/inttegro/message_template/sms_content.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the sms content object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] message_template
+    #   SMS body template.
+    #
+    #   Required in the API payload. Wire name: `message_template`.
+    #   @return [String]
+    class SMSContent < T::Struct
+      const :message_template, String
+    end
+  end
+end

data/lib/inttegro/message_template/status.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class MessageTemplate
+    # String-backed values accepted by the Inttegro API for Inttegro::MessageTemplate::Status.
+    #
+    # Use the constants below when constructing a request. `#serialize` returns the documented
+    # string wire value received from or sent to the API.
+    #
+    # @api public
+    class Status < T::Enum
+      enums do
+        # Serialized wire value: `draft`.
+        # @return [Inttegro::MessageTemplate::Status]
+        DRAFT = new("draft")
+        # Serialized wire value: `published`.
+        # @return [Inttegro::MessageTemplate::Status]
+        PUBLISHED = new("published")
+        # Serialized wire value: `archived`.
+        # @return [Inttegro::MessageTemplate::Status]
+        ARCHIVED = new("archived")
+      end
+    end
+  end
+end

data/lib/inttegro/message_template/update_request.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "attachment_ids"
+require_relative "channel"
+require_relative "email_content"
+require_relative "sms_content"
+require_relative "variable_input"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the update request object in the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] id
+    #   API-generated message template id.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] name
+    #   Human-readable template name.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `name`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] about
+    #   Optional description of when this template should be used.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `about`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] channel
+    #   Existing template channel. Channels cannot be changed.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `channel`.
+    #   @return [Inttegro::MessageTemplate::Channel, nil]
+    #
+    # @!attribute [r] purpose
+    #   Caller-defined purpose for filtering and analytics.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `purpose`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] locale
+    #   Value of the `locale` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `locale`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] variables
+    #   Value of the `variables` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `variables`.
+    #   @return [Array<Inttegro::MessageTemplate::VariableInput>, nil]
+    #
+    # @!attribute [r] sms
+    #   Value of the `sms` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sms`.
+    #   @return [Inttegro::MessageTemplate::SMSContent, nil]
+    #
+    # @!attribute [r] email
+    #   Value of the `email` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email`.
+    #   @return [Inttegro::MessageTemplate::EmailContent, nil]
+    #
+    # @!attribute [r] attachments
+    #   Stored file IDs returned by previews. Chime send, schedule, and broadcast currently reject
+    #   stored-template attachments.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `attachments`.
+    #   @return [Inttegro::MessageTemplate::AttachmentIDs, nil]
+    class UpdateRequest < T::Struct
+      const :id, String
+      const :name, T.nilable(String), default: nil
+      const :about, T.nilable(String), default: nil
+      const :channel, T.nilable(Inttegro::MessageTemplate::Channel), default: nil
+      const :purpose, T.nilable(String), default: nil
+      const :locale, T.nilable(String), default: nil
+      const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), default: nil
+      const :sms, T.nilable(Inttegro::MessageTemplate::SMSContent), default: nil
+      const :email, T.nilable(Inttegro::MessageTemplate::EmailContent), default: nil
+      const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
+    end
+  end
+end