inttegro 4.3.1 → 6.0.0

data/lib/inttegro/chime/email_schema_markup.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 "email_schema_kind"
+
+module Inttegro
+  class Chime
+    # Schema.org JSON-LD markup generated at email send time.
+    #
+    # 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] kind
+    #   Classification for the generated markup
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `kind`.
+    #   @return [Inttegro::Chime::EmailSchemaKind, nil]
+    #
+    # @!attribute [r] json_ld
+    #   Deliberately extensible JSON object whose keys and values are defined by the selected
+    #   integration or resource subtype.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `json_ld`.
+    #   @return [Hash{String => Object}, nil]
+    class EmailSchemaMarkup < T::Struct
+      const :kind, T.nilable(Inttegro::Chime::EmailSchemaKind), default: nil
+      const :json_ld, T.nilable(T::Hash[String, Object]), default: nil
+    end
+  end
+end

data/lib/inttegro/chime/inline_recipient.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 "inline_recipient_variant1"
+require_relative "inline_recipient_variant2"
+
+module Inttegro
+  class Chime
+    # Typed representation of the inline recipient object in the Inttegro API.
+    #
+    # @api public
+    # @return [Inttegro::Chime::InlineRecipientVariant1, Inttegro::Chime::InlineRecipientVariant2]
+    InlineRecipient = T.type_alias { T.any(Inttegro::Chime::InlineRecipientVariant1, Inttegro::Chime::InlineRecipientVariant2) }
+  end
+end

data/lib/inttegro/chime/inline_recipient_variant1.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "inline_recipient_variant1_phone"
+require_relative "inline_recipient_variant1_type"
+
+module Inttegro
+  class Chime
+    # Typed representation of the inline recipient variant1 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
+    #   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]
+    #
+    # @!attribute [r] phone
+    #   Value of the `phone` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `phone`.
+    #   @return [Inttegro::Chime::InlineRecipientVariant1Phone]
+    #
+    # @!attribute [r] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Chime::InlineRecipientVariant1Type]
+    class InlineRecipientVariant1 < T::Struct
+      const :name, T.nilable(String), default: nil
+      const :phone, Inttegro::Chime::InlineRecipientVariant1Phone
+      const :type, Inttegro::Chime::InlineRecipientVariant1Type
+    end
+  end
+end

data/lib/inttegro/chime/inline_recipient_variant1_phone.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 Chime
+    # Typed representation of the inline recipient variant1 phone 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 [String]
+    class InlineRecipientVariant1Phone < T::Struct
+      const :number, String
+    end
+  end
+end

data/lib/inttegro/chime/inline_recipient_variant1_type.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 Chime
+    # String-backed values accepted by the Inttegro API for
+    # Inttegro::Chime::InlineRecipientVariant1Type.
+    #
+    # 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 InlineRecipientVariant1Type < T::Enum
+      enums do
+        # Serialized wire value: `phone`.
+        # @return [Inttegro::Chime::InlineRecipientVariant1Type]
+        PHONE = new("phone")
+      end
+    end
+  end
+end

data/lib/inttegro/chime/inline_recipient_variant2.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "inline_recipient_variant2_email"
+require_relative "inline_recipient_variant2_type"
+
+module Inttegro
+  class Chime
+    # Typed representation of the inline recipient variant2 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] email
+    #   Value of the `email` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `email`.
+    #   @return [Inttegro::Chime::InlineRecipientVariant2Email]
+    #
+    # @!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]
+    #
+    # @!attribute [r] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Chime::InlineRecipientVariant2Type]
+    class InlineRecipientVariant2 < T::Struct
+      const :email, Inttegro::Chime::InlineRecipientVariant2Email
+      const :name, T.nilable(String), default: nil
+      const :type, Inttegro::Chime::InlineRecipientVariant2Type
+    end
+  end
+end

data/lib/inttegro/chime/inline_recipient_variant2_email.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 Chime
+    # Typed representation of the inline recipient variant2 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] address
+    #   Value of the `address` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `address`.
+    #   @return [String]
+    class InlineRecipientVariant2Email < T::Struct
+      const :address, String
+    end
+  end
+end

data/lib/inttegro/chime/inline_recipient_variant2_type.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 Chime
+    # String-backed values accepted by the Inttegro API for
+    # Inttegro::Chime::InlineRecipientVariant2Type.
+    #
+    # 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 InlineRecipientVariant2Type < T::Enum
+      enums do
+        # Serialized wire value: `email`.
+        # @return [Inttegro::Chime::InlineRecipientVariant2Type]
+        EMAIL = new("email")
+      end
+    end
+  end
+end

data/lib/inttegro/chime/lookup_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 Chime
+    # Request to look up a chime by ID
+    #
+    # 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] chime_id
+    #   Unique identifier of the chime to look up
+    #
+    #   Required in the API payload. Wire name: `chime_id`.
+    #   @return [String]
+    class LookupRequest < T::Struct
+      const :chime_id, String
+    end
+  end
+end

data/lib/inttegro/chime/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 "chime"
+
+module Inttegro
+  class Chime
+    # 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
+    #   Page number returned
+    #
+    #   Required in the API payload. Wire name: `number`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] size
+    #   Page size returned
+    #
+    #   Required in the API payload. Wire name: `size`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] chimes
+    #   Chimes in this page
+    #
+    #   Required in the API payload. Wire name: `chimes`.
+    #   @return [Array<Inttegro::Chime>]
+    class Page < T::Struct
+      const :number, Integer
+      const :size, Integer
+      const :chimes, T::Array[Inttegro::Chime]
+    end
+  end
+end

data/lib/inttegro/chime/page_request.rb

@@ -0,0 +1,49 @@
+# 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 Chime
+    # Request to retrieve a page of chimes
+    #
+    # 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] customer_id
+    #   Restrict the page to chimes associated with this customer
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `customer_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] page_number
+    #   1-based page index to fetch
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page_number`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] page_size
+    #   Number of chimes to return
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page_size`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] recipient
+    #   Restrict the page to chimes whose recipient exactly matches this phone number or email
+    #   address
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `recipient`.
+    #   @return [String, nil]
+    class PageRequest < T::Struct
+      const :customer_id, T.nilable(String), default: nil
+      const :page_number, T.nilable(Integer), default: nil
+      const :page_size, T.nilable(Integer), default: nil
+      const :recipient, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/chime/page_response.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 Chime
+    # Response containing a page of chimes
+    #
+    # 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 [Inttegro::Chime::Page, nil]
+    class PageResponse < T::Struct
+      const :page, T.nilable(Inttegro::Chime::Page), default: nil
+    end
+  end
+end

data/lib/inttegro/chime/recipient.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 "inline_recipient"
+require_relative "saved_customer_recipient"
+
+module Inttegro
+  class Chime
+    # Typed representation of the recipient object in the Inttegro API.
+    #
+    # @api public
+    # @return [Inttegro::Chime::InlineRecipient, Inttegro::Chime::SavedCustomerRecipient]
+    Recipient = T.type_alias { T.any(Inttegro::Chime::InlineRecipient, Inttegro::Chime::SavedCustomerRecipient) }
+  end
+end

data/lib/inttegro/chime/recipient_detail.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "recipient_detail_email"
+require_relative "recipient_detail_phone"
+require_relative "recipient_type"
+
+module Inttegro
+  class Chime
+    # Recipient information in response
+    #
+    # 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] type
+    #   Contact type
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Chime::RecipientType]
+    #
+    # @!attribute [r] name
+    #   Recipient name
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `name`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] phone
+    #   Value of the `phone` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `phone`.
+    #   @return [Inttegro::Chime::RecipientDetailPhone, 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::Chime::RecipientDetailEmail, nil]
+    class RecipientDetail < T::Struct
+      const :type, Inttegro::Chime::RecipientType
+      const :name, T.nilable(String), default: nil
+      const :phone, T.nilable(Inttegro::Chime::RecipientDetailPhone), default: nil
+      const :email, T.nilable(Inttegro::Chime::RecipientDetailEmail), default: nil
+    end
+  end
+end

data/lib/inttegro/chime/recipient_detail_email.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 Chime
+    # Typed representation of the recipient detail 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] address
+    #   Value of the `address` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `address`.
+    #   @return [String]
+    class RecipientDetailEmail < T::Struct
+      const :address, String
+    end
+  end
+end

data/lib/inttegro/chime/recipient_detail_phone.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 Chime
+    # Typed representation of the recipient detail phone 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 [String]
+    class RecipientDetailPhone < T::Struct
+      const :number, String
+    end
+  end
+end

data/lib/inttegro/chime/recipient_type.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 Chime
+    # Contact type
+    #
+    # 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 RecipientType < T::Enum
+      enums do
+        # Serialized wire value: `phone`.
+        # @return [Inttegro::Chime::RecipientType]
+        PHONE = new("phone")
+        # Serialized wire value: `email`.
+        # @return [Inttegro::Chime::RecipientType]
+        EMAIL = new("email")
+      end
+    end
+  end
+end

data/lib/inttegro/chime/response.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 "chime"
+
+module Inttegro
+  class Chime
+    # Response containing chime details
+    #
+    # 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] chime
+    #   A notification sent to one recipient
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `chime`.
+    #   @return [Inttegro::Chime, nil]
+    class Response < T::Struct
+      const :chime, T.nilable(Inttegro::Chime), default: nil
+    end
+  end
+end

data/lib/inttegro/chime/saved_customer_recipient.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 "transport"
+
+module Inttegro
+  class Chime
+    # Typed representation of the saved customer recipient 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] customer_id
+    #   Value of the `customer_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `customer_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] transport
+    #   Value of the `transport` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `transport`.
+    #   @return [Inttegro::Chime::Transport]
+    class SavedCustomerRecipient < T::Struct
+      const :customer_id, String
+      const :transport, Inttegro::Chime::Transport
+    end
+  end
+end