inttegro 5.0.0 → 6.0.1

data/lib/inttegro/message_template/create_email_request.rb

@@ -0,0 +1,81 @@
+# 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 "create_email_request_channel"
+require_relative "email_content"
+require_relative "variable_input"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the create email 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] about
+    #   Value of the `about` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `about`.
+    #   @return [String, 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]
+    #
+    # @!attribute [r] channel
+    #   Value of the `channel` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `channel`.
+    #   @return [Inttegro::MessageTemplate::CreateEmailRequestChannel]
+    #
+    # @!attribute [r] email
+    #   Value of the `email` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `email`.
+    #   @return [Inttegro::MessageTemplate::EmailContent]
+    #
+    # @!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] name
+    #   Value of the `name` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] purpose
+    #   Value of the `purpose` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `purpose`.
+    #   @return [String]
+    #
+    # @!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]
+    class CreateEmailRequest < T::Struct
+      const :about, T.nilable(String), default: nil
+      const :attachments, T.nilable(Inttegro::MessageTemplate::AttachmentIDs), default: nil
+      const :channel, Inttegro::MessageTemplate::CreateEmailRequestChannel
+      const :email, Inttegro::MessageTemplate::EmailContent
+      const :locale, T.nilable(String), default: nil
+      const :name, String
+      const :purpose, String
+      const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), default: nil
+    end
+  end
+end

data/lib/inttegro/message_template/create_email_request_channel.rb

@@ -0,0 +1,25 @@
+# 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::CreateEmailRequestChannel.
+    #
+    # 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 CreateEmailRequestChannel < T::Enum
+      enums do
+        # Serialized wire value: `email`.
+        # @return [Inttegro::MessageTemplate::CreateEmailRequestChannel]
+        EMAIL = new("email")
+      end
+    end
+  end
+end

data/lib/inttegro/message_template/create_fields.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 "variable_input"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the create fields 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] name
+    #   Human-readable template name.
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!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
+    #   Delivery channel this template renders for.
+    #
+    #   Required in the API payload. Wire name: `channel`.
+    #   @return [Inttegro::MessageTemplate::Channel]
+    #
+    # @!attribute [r] purpose
+    #   Caller-defined purpose for filtering and analytics.
+    #
+    #   Required in the API payload. Wire name: `purpose`.
+    #   @return [String]
+    #
+    # @!attribute [r] locale
+    #   Template locale. Defaults to `en` when omitted.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `locale`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] variables
+    #   Variables accepted by this template.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `variables`.
+    #   @return [Array<Inttegro::MessageTemplate::VariableInput>, nil]
+    class CreateFields < T::Struct
+      const :name, String
+      const :about, T.nilable(String), default: nil
+      const :channel, Inttegro::MessageTemplate::Channel
+      const :purpose, String
+      const :locale, T.nilable(String), default: nil
+      const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), default: nil
+    end
+  end
+end

data/lib/inttegro/message_template/create_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "create_email_request"
+require_relative "create_sms_request"
+
+module Inttegro
+  class MessageTemplate
+    # Create request for one reusable SMS or email message template.
+    #
+    # @api public
+    # @return [Inttegro::MessageTemplate::CreateSMSRequest, Inttegro::MessageTemplate::CreateEmailRequest]
+    CreateRequest = T.type_alias { T.any(Inttegro::MessageTemplate::CreateSMSRequest, Inttegro::MessageTemplate::CreateEmailRequest) }
+  end
+end

data/lib/inttegro/message_template/create_sms_request.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "create_sms_request_channel"
+require_relative "sms_content"
+require_relative "variable_input"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the create sms 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] about
+    #   Value of the `about` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `about`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] channel
+    #   Value of the `channel` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `channel`.
+    #   @return [Inttegro::MessageTemplate::CreateSMSRequestChannel]
+    #
+    # @!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] name
+    #   Value of the `name` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] purpose
+    #   Value of the `purpose` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `purpose`.
+    #   @return [String]
+    #
+    # @!attribute [r] sms
+    #   Value of the `sms` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `sms`.
+    #   @return [Inttegro::MessageTemplate::SMSContent]
+    #
+    # @!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]
+    class CreateSMSRequest < T::Struct
+      const :about, T.nilable(String), default: nil
+      const :channel, Inttegro::MessageTemplate::CreateSMSRequestChannel
+      const :locale, T.nilable(String), default: nil
+      const :name, String
+      const :purpose, String
+      const :sms, Inttegro::MessageTemplate::SMSContent
+      const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::VariableInput]), default: nil
+    end
+  end
+end

data/lib/inttegro/message_template/create_sms_request_channel.rb

@@ -0,0 +1,25 @@
+# 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::CreateSMSRequestChannel.
+    #
+    # 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 CreateSMSRequestChannel < T::Enum
+      enums do
+        # Serialized wire value: `sms`.
+        # @return [Inttegro::MessageTemplate::CreateSMSRequestChannel]
+        SMS = new("sms")
+      end
+    end
+  end
+end

data/lib/inttegro/message_template/email_content.rb

@@ -0,0 +1,56 @@
+# 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"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the email 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] subject
+    #   Email subject template.
+    #
+    #   Required in the API payload. Wire name: `subject`.
+    #   @return [String]
+    #
+    # @!attribute [r] html
+    #   HTML email body template.
+    #
+    #   Required in the API payload. Wire name: `html`.
+    #   @return [String]
+    #
+    # @!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]
+    class EmailContent < T::Struct
+      const :subject, String
+      const :html, String
+      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
+    end
+  end
+end

data/lib/inttegro/message_template/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 "message_template"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the 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] 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]
+    class Envelope < T::Struct
+      const :message_template, Inttegro::MessageTemplate
+    end
+  end
+end

data/lib/inttegro/message_template/id_request.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 id 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]
+    class IDRequest < T::Struct
+      const :id, String
+    end
+  end
+end

data/lib/inttegro/message_template/mailbox.rb

@@ -0,0 +1,34 @@
+# 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 mailbox 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] address
+    #   Literal or templated mailbox address, such as `{{recipient_email}}`.
+    #
+    #   Required in the API payload. Wire name: `address`.
+    #   @return [String]
+    #
+    # @!attribute [r] name
+    #   Value of the `name` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `name`.
+    #   @return [String, nil]
+    class Mailbox < T::Struct
+      const :address, String
+      const :name, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/message_template/message_template.rb

@@ -0,0 +1,158 @@
+# 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 "status"
+require_relative "variable"
+
+module Inttegro
+  # Typed representation of the message template 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 unique template id.
+  #
+  #   Required in the API payload. Wire name: `id`.
+  #   @return [String]
+  #
+  # @!attribute [r] name
+  #   Value of the `name` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `name`.
+  #   @return [String]
+  #
+  # @!attribute [r] about
+  #   Value of the `about` field in the Inttegro API payload.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `about`.
+  #   @return [String, nil]
+  #
+  # @!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] purpose
+  #   Value of the `purpose` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `purpose`.
+  #   @return [String]
+  #
+  # @!attribute [r] locale
+  #   Value of the `locale` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `locale`.
+  #   @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::MessageTemplate::Status]
+  #
+  # @!attribute [r] version
+  #   Value of the `version` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `version`.
+  #   @return [Integer]
+  #
+  # @!attribute [r] published_version
+  #   Value of the `published_version` field in the Inttegro API payload.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `published_version`.
+  #   @return [Integer, nil]
+  #
+  # @!attribute [r] draft_version
+  #   Value of the `draft_version` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `draft_version`.
+  #   @return [Integer]
+  #
+  # @!attribute [r] has_unpublished_changes
+  #   Value of the `has_unpublished_changes` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `has_unpublished_changes`.
+  #   @return [Boolean]
+  #
+  # @!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::Variable>, 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]
+  #
+  # @!attribute [r] created_at
+  #   Value of the `created_at` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `created_at`.
+  #   @return [Time]
+  #
+  # @!attribute [r] updated_at
+  #   Value of the `updated_at` field in the Inttegro API payload.
+  #
+  #   Required in the API payload. Wire name: `updated_at`.
+  #   @return [Time]
+  #
+  # @!attribute [r] published_at
+  #   Value of the `published_at` field in the Inttegro API payload.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `published_at`.
+  #   @return [Time, nil]
+  #
+  # @!attribute [r] archived_at
+  #   Value of the `archived_at` field in the Inttegro API payload.
+  #
+  #   Optional in the API payload; omitted values default to `nil`. Wire name: `archived_at`.
+  #   @return [Time, nil]
+  class MessageTemplate
+    const :id, String
+    const :name, String
+    const :about, T.nilable(String), default: nil
+    const :channel, Inttegro::MessageTemplate::Channel
+    const :purpose, String
+    const :locale, String
+    const :status, Inttegro::MessageTemplate::Status
+    const :version, Integer
+    const :published_version, T.nilable(Integer), default: nil
+    const :draft_version, Integer
+    const :has_unpublished_changes, T::Boolean
+    const :variables, T.nilable(T::Array[Inttegro::MessageTemplate::Variable]), 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
+    const :created_at, Time
+    const :updated_at, Time
+    const :published_at, T.nilable(Time), default: nil
+    const :archived_at, T.nilable(Time), default: nil
+  end
+end

data/lib/inttegro/message_template/page.rb

@@ -0,0 +1,42 @@
+# 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"
+
+module Inttegro
+  class MessageTemplate
+    # Typed representation of the page 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] number
+    #   Value of the `number` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `number`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] size
+    #   Number of templates returned in this page after filters are applied.
+    #
+    #   Required in the API payload. Wire name: `size`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] message_templates
+    #   Value of the `message_templates` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `message_templates`.
+    #   @return [Array<Inttegro::MessageTemplate>]
+    class Page < T::Struct
+      const :number, Integer
+      const :size, Integer
+      const :message_templates, T::Array[Inttegro::MessageTemplate]
+    end
+  end
+end

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