telnyx 5.162.0 → 5.164.0

data/lib/telnyx/models/storage/cloudfs_filesystem.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      class CloudfsFilesystem < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute meta_token
+        #   Metadata access token, in cleartext. Returned only by create and
+        #   rotate-meta-token and not retrievable afterwards — store it securely.
+        #
+        #   @return [String, nil]
+        optional :meta_token, String
+
+        # @!attribute meta_url
+        #   PostgreSQL connection URL for the filesystem's metadata database. In create and
+        #   rotate-meta-token responses it embeds the metadata token as the password:
+        #   `postgres://<database>:<meta_token>@us-east-1.telnyxcloudfs.com:5432/<database>?sslmode=require`
+        #   (the example below is shown without the credential; the actual response includes
+        #   it). Pass it to `juicefs mount`: the storage configuration is baked in at
+        #   provisioning, so the metadata URL is all a client needs to mount the filesystem.
+        #
+        #   @return [String, nil]
+        optional :meta_url, String
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute record_type
+        #
+        #   @return [String, nil]
+        optional :record_type, String
+
+        # @!attribute region
+        #
+        #   @return [String, nil]
+        optional :region, String
+
+        # @!attribute s3_bucket
+        #   Name of the bucket that stores this filesystem's data. Created during
+        #   provisioning.
+        #
+        #   @return [String, nil]
+        optional :s3_bucket, String
+
+        # @!attribute s3_endpoint
+        #   URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+        #
+        #   @return [String, nil]
+        optional :s3_endpoint, String
+
+        # @!attribute status
+        #   Lifecycle status of the filesystem. `ready` means it is fully provisioned and
+        #   usable. `needs_format` means the storage bucket and metadata database were
+        #   provisioned but the filesystem has not yet been formatted — run `juicefs format`
+        #   with the filesystem's `meta_url` before mounting. `failed` means the last
+        #   lifecycle action failed — see the filesystem's `error` message. `deleted`
+        #   appears only in the delete response: deleted filesystems are excluded from list
+        #   results and return a `404` on retrieval.
+        #
+        #   @return [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus, nil]
+        optional :status, enum: -> { Telnyx::Storage::CloudfsFilesystemStatus }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!method initialize(id: nil, created_at: nil, meta_token: nil, meta_url: nil, name: nil, record_type: nil, region: nil, s3_bucket: nil, s3_endpoint: nil, status: nil, updated_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Storage::CloudfsFilesystem} for more details.
+        #
+        #   A CloudFS filesystem, including its metadata credential. This shape is returned
+        #   only by create and rotate-meta-token.
+        #
+        #   @param id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param meta_token [String] Metadata access token, in cleartext. Returned only by create and rotate-meta-tok
+        #
+        #   @param meta_url [String] PostgreSQL connection URL for the filesystem's metadata database. In create and
+        #
+        #   @param name [String]
+        #
+        #   @param record_type [String]
+        #
+        #   @param region [String]
+        #
+        #   @param s3_bucket [String] Name of the bucket that stores this filesystem's data. Created during provisioni
+        #
+        #   @param s3_endpoint [String] URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+        #
+        #   @param status [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus] Lifecycle status of the filesystem. `ready` means it is fully provisioned and us
+        #
+        #   @param updated_at [Time]
+      end
+    end
+  end
+end

data/lib/telnyx/models/storage/cloudfs_filesystem_detail.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Storage
+      class CloudfsFilesystemDetail < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute error
+        #   Explanation of the most recent failed lifecycle action. Present only when the
+        #   filesystem is in a `failed` state.
+        #
+        #   @return [String, nil]
+        optional :error, String
+
+        # @!attribute meta_url
+        #   PostgreSQL connection URL for the filesystem's metadata database, without the
+        #   credential. Combine it with your stored metadata token, or issue a new token
+        #   with rotate-meta-token.
+        #
+        #   @return [String, nil]
+        optional :meta_url, String
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute record_type
+        #
+        #   @return [String, nil]
+        optional :record_type, String
+
+        # @!attribute region
+        #
+        #   @return [String, nil]
+        optional :region, String
+
+        # @!attribute s3_bucket
+        #   Name of the bucket that stores this filesystem's data. Created during
+        #   provisioning.
+        #
+        #   @return [String, nil]
+        optional :s3_bucket, String
+
+        # @!attribute s3_endpoint
+        #   URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+        #
+        #   @return [String, nil]
+        optional :s3_endpoint, String
+
+        # @!attribute status
+        #   Lifecycle status of the filesystem. `ready` means it is fully provisioned and
+        #   usable. `needs_format` means the storage bucket and metadata database were
+        #   provisioned but the filesystem has not yet been formatted — run `juicefs format`
+        #   with the filesystem's `meta_url` before mounting. `failed` means the last
+        #   lifecycle action failed — see the filesystem's `error` message. `deleted`
+        #   appears only in the delete response: deleted filesystems are excluded from list
+        #   results and return a `404` on retrieval.
+        #
+        #   @return [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus, nil]
+        optional :status, enum: -> { Telnyx::Storage::CloudfsFilesystemStatus }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!method initialize(id: nil, created_at: nil, error: nil, meta_url: nil, name: nil, record_type: nil, region: nil, s3_bucket: nil, s3_endpoint: nil, status: nil, updated_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Storage::CloudfsFilesystemDetail} for more details.
+        #
+        #   A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits
+        #   the credential and there is no `meta_token` field — the token is only returned
+        #   by create and rotate-meta-token.
+        #
+        #   @param id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param error [String] Explanation of the most recent failed lifecycle action. Present only when the fi
+        #
+        #   @param meta_url [String] PostgreSQL connection URL for the filesystem's metadata database, without the cr
+        #
+        #   @param name [String]
+        #
+        #   @param record_type [String]
+        #
+        #   @param region [String]
+        #
+        #   @param s3_bucket [String] Name of the bucket that stores this filesystem's data. Created during provisioni
+        #
+        #   @param s3_endpoint [String] URL of the Telnyx Cloud Storage endpoint backing this filesystem.
+        #
+        #   @param status [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus] Lifecycle status of the filesystem. `ready` means it is fully provisioned and us
+        #
+        #   @param updated_at [Time]
+      end
+    end
+  end
+end

data/lib/telnyx/models/storage/cloudfs_filesystem_detail_response_wrapper.rb

@@ -10,119 +10,15 @@ module Telnyx
         #   the credential and there is no `meta_token` field — the token is only returned
         #   by create and rotate-meta-token.
         #
-        #   @return [Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper::Data, nil]
-        optional :data, -> { Telnyx::Storage::CloudfsFilesystemDetailResponseWrapper::Data }
+        #   @return [Telnyx::Models::Storage::CloudfsFilesystemDetail, nil]
+        optional :data, -> { Telnyx::Storage::CloudfsFilesystemDetail }
 
         # @!method initialize(data: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper} for more
         #   details.
         #
-        #   @param data [Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper::Data] A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits th
-
-        # @see Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper#data
-        class Data < Telnyx::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String, nil]
-          optional :id, String
-
-          # @!attribute created_at
-          #
-          #   @return [Time, nil]
-          optional :created_at, Time
-
-          # @!attribute error
-          #   Explanation of the most recent failed lifecycle action. Present only when the
-          #   filesystem is in a `failed` state.
-          #
-          #   @return [String, nil]
-          optional :error, String
-
-          # @!attribute meta_url
-          #   PostgreSQL connection URL for the filesystem's metadata database, without the
-          #   credential. Combine it with your stored metadata token, or issue a new token
-          #   with rotate-meta-token.
-          #
-          #   @return [String, nil]
-          optional :meta_url, String
-
-          # @!attribute name
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!attribute record_type
-          #
-          #   @return [String, nil]
-          optional :record_type, String
-
-          # @!attribute region
-          #
-          #   @return [String, nil]
-          optional :region, String
-
-          # @!attribute s3_bucket
-          #   Name of the bucket that stores this filesystem's data. Created during
-          #   provisioning.
-          #
-          #   @return [String, nil]
-          optional :s3_bucket, String
-
-          # @!attribute s3_endpoint
-          #   URL of the Telnyx Cloud Storage endpoint backing this filesystem.
-          #
-          #   @return [String, nil]
-          optional :s3_endpoint, String
-
-          # @!attribute status
-          #   Lifecycle status of the filesystem. `ready` means it is fully provisioned and
-          #   usable. `needs_format` means the storage bucket and metadata database were
-          #   provisioned but the filesystem has not yet been formatted — run `juicefs format`
-          #   with the filesystem's `meta_url` before mounting. `failed` means the last
-          #   lifecycle action failed — see the filesystem's `error` message. `deleted`
-          #   appears only in the delete response: deleted filesystems are excluded from list
-          #   results and return a `404` on retrieval.
-          #
-          #   @return [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus, nil]
-          optional :status, enum: -> { Telnyx::Storage::CloudfsFilesystemStatus }
-
-          # @!attribute updated_at
-          #
-          #   @return [Time, nil]
-          optional :updated_at, Time
-
-          # @!method initialize(id: nil, created_at: nil, error: nil, meta_url: nil, name: nil, record_type: nil, region: nil, s3_bucket: nil, s3_endpoint: nil, status: nil, updated_at: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::Storage::CloudfsFilesystemDetailResponseWrapper::Data} for more
-          #   details.
-          #
-          #   A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits
-          #   the credential and there is no `meta_token` field — the token is only returned
-          #   by create and rotate-meta-token.
-          #
-          #   @param id [String]
-          #
-          #   @param created_at [Time]
-          #
-          #   @param error [String] Explanation of the most recent failed lifecycle action. Present only when the fi
-          #
-          #   @param meta_url [String] PostgreSQL connection URL for the filesystem's metadata database, without the cr
-          #
-          #   @param name [String]
-          #
-          #   @param record_type [String]
-          #
-          #   @param region [String]
-          #
-          #   @param s3_bucket [String] Name of the bucket that stores this filesystem's data. Created during provisioni
-          #
-          #   @param s3_endpoint [String] URL of the Telnyx Cloud Storage endpoint backing this filesystem.
-          #
-          #   @param status [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus] Lifecycle status of the filesystem. `ready` means it is fully provisioned and us
-          #
-          #   @param updated_at [Time]
-        end
+        #   @param data [Telnyx::Models::Storage::CloudfsFilesystemDetail] A CloudFS filesystem as returned by get, update, and delete. `meta_url` omits th
       end
     end
   end

data/lib/telnyx/models/storage/cloudfs_filesystem_response_wrapper.rb

@@ -9,120 +9,14 @@ module Telnyx
         #   A CloudFS filesystem, including its metadata credential. This shape is returned
         #   only by create and rotate-meta-token.
         #
-        #   @return [Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper::Data, nil]
-        optional :data, -> { Telnyx::Storage::CloudfsFilesystemResponseWrapper::Data }
+        #   @return [Telnyx::Models::Storage::CloudfsFilesystem, nil]
+        optional :data, -> { Telnyx::Storage::CloudfsFilesystem }
 
         # @!method initialize(data: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper} for more details.
         #
-        #   @param data [Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper::Data] A CloudFS filesystem, including its metadata credential. This shape is returned
-
-        # @see Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper#data
-        class Data < Telnyx::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String, nil]
-          optional :id, String
-
-          # @!attribute created_at
-          #
-          #   @return [Time, nil]
-          optional :created_at, Time
-
-          # @!attribute meta_token
-          #   Metadata access token, in cleartext. Returned only by create and
-          #   rotate-meta-token and not retrievable afterwards — store it securely.
-          #
-          #   @return [String, nil]
-          optional :meta_token, String
-
-          # @!attribute meta_url
-          #   PostgreSQL connection URL for the filesystem's metadata database. In create and
-          #   rotate-meta-token responses it embeds the metadata token as the password:
-          #   `postgres://<database>:<meta_token>@us-east-1.telnyxcloudfs.com:5432/<database>?sslmode=require`
-          #   (the example below is shown without the credential; the actual response includes
-          #   it). Pass it to `juicefs mount`: the storage configuration is baked in at
-          #   provisioning, so the metadata URL is all a client needs to mount the filesystem.
-          #
-          #   @return [String, nil]
-          optional :meta_url, String
-
-          # @!attribute name
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!attribute record_type
-          #
-          #   @return [String, nil]
-          optional :record_type, String
-
-          # @!attribute region
-          #
-          #   @return [String, nil]
-          optional :region, String
-
-          # @!attribute s3_bucket
-          #   Name of the bucket that stores this filesystem's data. Created during
-          #   provisioning.
-          #
-          #   @return [String, nil]
-          optional :s3_bucket, String
-
-          # @!attribute s3_endpoint
-          #   URL of the Telnyx Cloud Storage endpoint backing this filesystem.
-          #
-          #   @return [String, nil]
-          optional :s3_endpoint, String
-
-          # @!attribute status
-          #   Lifecycle status of the filesystem. `ready` means it is fully provisioned and
-          #   usable. `needs_format` means the storage bucket and metadata database were
-          #   provisioned but the filesystem has not yet been formatted — run `juicefs format`
-          #   with the filesystem's `meta_url` before mounting. `failed` means the last
-          #   lifecycle action failed — see the filesystem's `error` message. `deleted`
-          #   appears only in the delete response: deleted filesystems are excluded from list
-          #   results and return a `404` on retrieval.
-          #
-          #   @return [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus, nil]
-          optional :status, enum: -> { Telnyx::Storage::CloudfsFilesystemStatus }
-
-          # @!attribute updated_at
-          #
-          #   @return [Time, nil]
-          optional :updated_at, Time
-
-          # @!method initialize(id: nil, created_at: nil, meta_token: nil, meta_url: nil, name: nil, record_type: nil, region: nil, s3_bucket: nil, s3_endpoint: nil, status: nil, updated_at: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::Storage::CloudfsFilesystemResponseWrapper::Data} for more
-          #   details.
-          #
-          #   A CloudFS filesystem, including its metadata credential. This shape is returned
-          #   only by create and rotate-meta-token.
-          #
-          #   @param id [String]
-          #
-          #   @param created_at [Time]
-          #
-          #   @param meta_token [String] Metadata access token, in cleartext. Returned only by create and rotate-meta-tok
-          #
-          #   @param meta_url [String] PostgreSQL connection URL for the filesystem's metadata database. In create and
-          #
-          #   @param name [String]
-          #
-          #   @param record_type [String]
-          #
-          #   @param region [String]
-          #
-          #   @param s3_bucket [String] Name of the bucket that stores this filesystem's data. Created during provisioni
-          #
-          #   @param s3_endpoint [String] URL of the Telnyx Cloud Storage endpoint backing this filesystem.
-          #
-          #   @param status [Symbol, Telnyx::Models::Storage::CloudfsFilesystemStatus] Lifecycle status of the filesystem. `ready` means it is fully provisioned and us
-          #
-          #   @param updated_at [Time]
-        end
+        #   @param data [Telnyx::Models::Storage::CloudfsFilesystem] A CloudFS filesystem, including its metadata credential. This shape is returned
       end
     end
   end

data/lib/telnyx/models/storage/sqldbs/action_query_params.rb

@@ -54,10 +54,8 @@ module Telnyx
 
             variant Telnyx::Internal::Type::Boolean
 
-            variant NilClass
-
             # @!method self.variants
-            #   @return [Array(String, Float, Boolean, nil)]
+            #   @return [Array(String, Float, Boolean)]
           end
         end
       end

data/lib/telnyx/models/sub_number_order_cancel_response.rb

@@ -6,11 +6,11 @@ module Telnyx
     class SubNumberOrderCancelResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::SubNumberOrder, nil]
-      optional :data, -> { Telnyx::SubNumberOrder }
+      #   @return [Telnyx::Models::NumbersSubNumberOrder, nil]
+      optional :data, -> { Telnyx::NumbersSubNumberOrder }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::SubNumberOrder]
+      #   @param data [Telnyx::Models::NumbersSubNumberOrder]
     end
   end
 end

data/lib/telnyx/models/sub_number_order_list_params.rb

@@ -10,7 +10,7 @@ module Telnyx
       # @!attribute filter
       #   Consolidated filter parameter (deepObject style). Originally: filter[status],
       #   filter[order_request_id], filter[country_code], filter[phone_number_type],
-      #   filter[phone_numbers_count]
+      #   filter[phone_numbers_count], filter[include_phone_numbers]
       #
       #   @return [Telnyx::Models::SubNumberOrderListParams::Filter, nil]
       optional :filter, -> { Telnyx::SubNumberOrderListParams::Filter }
@@ -30,6 +30,13 @@ module Telnyx
         #   @return [String, nil]
         optional :country_code, String
 
+        # @!attribute include_phone_numbers
+        #   Include the first 50 phone number objects in the results, including their
+        #   per-number regulatory requirement statuses
+        #
+        #   @return [Boolean, nil]
+        optional :include_phone_numbers, Telnyx::Internal::Type::Boolean
+
         # @!attribute order_request_id
         #   ID of the number order the sub number order belongs to
         #
@@ -54,13 +61,18 @@ module Telnyx
         #   @return [String, nil]
         optional :status, String
 
-        # @!method initialize(country_code: nil, order_request_id: nil, phone_number_type: nil, phone_numbers_count: nil, status: nil)
+        # @!method initialize(country_code: nil, include_phone_numbers: nil, order_request_id: nil, phone_number_type: nil, phone_numbers_count: nil, status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::SubNumberOrderListParams::Filter} for more details.
+        #
         #   Consolidated filter parameter (deepObject style). Originally: filter[status],
         #   filter[order_request_id], filter[country_code], filter[phone_number_type],
-        #   filter[phone_numbers_count]
+        #   filter[phone_numbers_count], filter[include_phone_numbers]
         #
         #   @param country_code [String] ISO alpha-2 country code.
         #
+        #   @param include_phone_numbers [Boolean] Include the first 50 phone number objects in the results, including their per-nu
+        #
         #   @param order_request_id [String] ID of the number order the sub number order belongs to
         #
         #   @param phone_number_type [String] Phone Number Type

data/lib/telnyx/models/sub_number_order_list_response.rb

@@ -6,8 +6,8 @@ module Telnyx
     class SubNumberOrderListResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Array<Telnyx::Models::SubNumberOrder>, nil]
-      optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::SubNumberOrder] }
+      #   @return [Array<Telnyx::Models::NumbersSubNumberOrder>, nil]
+      optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::NumbersSubNumberOrder] }
 
       # @!attribute meta
       #
@@ -15,7 +15,7 @@ module Telnyx
       optional :meta, -> { Telnyx::PaginationMeta }
 
       # @!method initialize(data: nil, meta: nil)
-      #   @param data [Array<Telnyx::Models::SubNumberOrder>]
+      #   @param data [Array<Telnyx::Models::NumbersSubNumberOrder>]
       #   @param meta [Telnyx::Models::PaginationMeta]
     end
   end

data/lib/telnyx/models/sub_number_order_retrieve_response.rb

@@ -6,11 +6,11 @@ module Telnyx
     class SubNumberOrderRetrieveResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::SubNumberOrder, nil]
-      optional :data, -> { Telnyx::SubNumberOrder }
+      #   @return [Telnyx::Models::NumbersSubNumberOrder, nil]
+      optional :data, -> { Telnyx::NumbersSubNumberOrder }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::SubNumberOrder]
+      #   @param data [Telnyx::Models::NumbersSubNumberOrder]
     end
   end
 end

data/lib/telnyx/models/sub_number_order_update_response.rb

@@ -6,11 +6,11 @@ module Telnyx
     class SubNumberOrderUpdateResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::SubNumberOrder, nil]
-      optional :data, -> { Telnyx::SubNumberOrder }
+      #   @return [Telnyx::Models::NumbersSubNumberOrder, nil]
+      optional :data, -> { Telnyx::NumbersSubNumberOrder }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::SubNumberOrder]
+      #   @param data [Telnyx::Models::NumbersSubNumberOrder]
     end
   end
 end

data/lib/telnyx/models/suppressed_recipient.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class SuppressedRecipient < Telnyx::Internal::Type::BaseModel
+      # @!attribute override_allowed
+      #   Whether an authorized send may override this suppression.
+      #
+      #   @return [Boolean]
+      required :override_allowed, Telnyx::Internal::Type::Boolean
+
+      # @!attribute reason
+      #   Suppression reason returned by the recipient suppression service.
+      #
+      #   @return [String]
+      required :reason, String
+
+      # @!attribute scope
+      #   Scope at which the suppression applies.
+      #
+      #   @return [String]
+      required :scope, String
+
+      # @!attribute to
+      #   Suppressed recipient email address.
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!method initialize(override_allowed:, reason:, scope:, to:)
+      #   @param override_allowed [Boolean] Whether an authorized send may override this suppression.
+      #
+      #   @param reason [String] Suppression reason returned by the recipient suppression service.
+      #
+      #   @param scope [String] Scope at which the suppression applies.
+      #
+      #   @param to [String] Suppressed recipient email address.
+    end
+  end
+end