inttegro 4.3.1 → 6.0.0

data/lib/inttegro/chime/send_request.rb

@@ -0,0 +1,82 @@
+# 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/reference"
+require_relative "email_message_input"
+require_relative "recipient"
+require_relative "send_request_request_meta"
+
+module Inttegro
+  class Chime
+    # Request to send a chime to a recipient. SMS recipients accept either `full_message` or
+    # `message_template`. Email recipients accept either `email` or `message_template`.
+    #
+    # 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] recipient
+    #   Value of the `recipient` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `recipient`.
+    #   @return [Inttegro::Chime::Recipient]
+    #
+    # @!attribute [r] full_message
+    #   Complete SMS message content. Use only with SMS recipients.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `full_message`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] email
+    #   Email content accepted for email chimes, broadcasts, and schedules.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email`.
+    #   @return [Inttegro::Chime::EmailMessageInput, nil]
+    #
+    # @!attribute [r] message_template
+    #   Value of the `message_template` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `message_template`.
+    #   @return [Inttegro::MessageTemplate::Reference, nil]
+    #
+    # @!attribute [r] sender_id
+    #   Sender identifier shown to recipient. Uses default sender if not provided.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sender_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] purpose
+    #   Purpose of this chime for categorization and analytics
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `purpose`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] custom_data
+    #   Merchant-defined string values attached to a resource. SDKs expose this as a semantic
+    #   collection rather than a raw map.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
+    #   @return [Hash{String => String}, nil]
+    #
+    # @!attribute [r] request_meta
+    #   Optional metadata controlling request processing
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `request_meta`.
+    #   @return [Inttegro::Chime::SendRequestRequestMeta, nil]
+    class SendRequest < T::Struct
+      const :recipient, Inttegro::Chime::Recipient
+      const :full_message, T.nilable(String), default: nil
+      const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
+      const :message_template, T.nilable(Inttegro::MessageTemplate::Reference), default: nil
+      const :sender_id, T.nilable(String), default: nil
+      const :purpose, T.nilable(String), default: nil
+      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :request_meta, T.nilable(Inttegro::Chime::SendRequestRequestMeta), default: nil
+    end
+  end
+end

data/lib/inttegro/chime/send_request_request_meta.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
+    # Optional metadata controlling request processing
+    #
+    # 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] idempotency_key
+    #   Unique key to prevent duplicate sends
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `idempotency_key`.
+    #   @return [String, nil]
+    class SendRequestRequestMeta < T::Struct
+      const :idempotency_key, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/chime/transmission.rb

@@ -0,0 +1,162 @@
+# 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_event"
+require_relative "transport"
+
+module Inttegro
+  class Chime
+    # Typed representation of the transmission 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]
+    #
+    # @!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] delivered_at
+    #   Value of the `delivered_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `delivered_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] email_events
+    #   Value of the `email_events` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email_events`.
+    #   @return [Array<Inttegro::Chime::EmailEvent>, nil]
+    #
+    # @!attribute [r] email_failure_code
+    #   Value of the `email_failure_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email_failure_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] email_failure_reason
+    #   Value of the `email_failure_reason` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email_failure_reason`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] email_status
+    #   Value of the `email_status` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email_status`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] error
+    #   Value of the `error` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `error`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] failed_at
+    #   Value of the `failed_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `failed_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] gateway
+    #   Value of the `gateway` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `gateway`.
+    #   @return [String]
+    #
+    # @!attribute [r] gateway_message_id
+    #   Value of the `gateway_message_id` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `gateway_message_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] id
+    #   Value of the `id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] initialized_at
+    #   Value of the `initialized_at` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `initialized_at`.
+    #   @return [Time]
+    #
+    # @!attribute [r] last_email_event_at
+    #   Value of the `last_email_event_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `last_email_event_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] mechanism
+    #   Value of the `mechanism` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `mechanism`.
+    #   @return [Inttegro::Chime::Transport]
+    #
+    # @!attribute [r] sent_at
+    #   Value of the `sent_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sent_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] sent_via
+    #   Value of the `sent_via` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sent_via`.
+    #   @return [Inttegro::Chime::Transport, nil]
+    #
+    # @!attribute [r] status
+    #   Value of the `status` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `status`.
+    #   @return [String]
+    #
+    # @!attribute [r] suppressed_at
+    #   Value of the `suppressed_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `suppressed_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] suppression_reason
+    #   Value of the `suppression_reason` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `suppression_reason`.
+    #   @return [String, nil]
+    class Transmission < T::Struct
+      const :address, String
+      const :created_at, Time
+      const :delivered_at, T.nilable(Time), default: nil
+      const :email_events, T.nilable(T::Array[Inttegro::Chime::EmailEvent]), default: nil
+      const :email_failure_code, T.nilable(String), default: nil
+      const :email_failure_reason, T.nilable(String), default: nil
+      const :email_status, T.nilable(String), default: nil
+      const :error, T.nilable(String), default: nil
+      const :failed_at, T.nilable(Time), default: nil
+      const :gateway, String
+      const :gateway_message_id, T.nilable(String), default: nil
+      const :id, String
+      const :initialized_at, Time
+      const :last_email_event_at, T.nilable(Time), default: nil
+      const :mechanism, Inttegro::Chime::Transport
+      const :sent_at, T.nilable(Time), default: nil
+      const :sent_via, T.nilable(Inttegro::Chime::Transport), default: nil
+      const :status, String
+      const :suppressed_at, T.nilable(Time), default: nil
+      const :suppression_reason, T.nilable(String), default: nil
+    end
+  end
+end

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

data/lib/inttegro/customer/address.rb

@@ -0,0 +1,76 @@
+# 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 Customer
+    # Typed representation of the address 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] city
+    #   Value of the `city` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `city`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] country
+    #   Value of the `country` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `country`.
+    #   @return [String]
+    #
+    # @!attribute [r] line1
+    #   Value of the `line1` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `line1`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] line2
+    #   Value of the `line2` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `line2`.
+    #   @return [String, nil]
+    #
+    # @!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_number
+    #   Value of the `phone_number` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `phone_number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] post_code
+    #   Value of the `post_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `post_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] region
+    #   Value of the `region` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `region`.
+    #   @return [String, nil]
+    class Address < T::Struct
+      const :city, T.nilable(String), default: nil
+      const :country, String
+      const :line1, T.nilable(String), default: nil
+      const :line2, T.nilable(String), default: nil
+      const :name, T.nilable(String), default: nil
+      const :phone_number, T.nilable(String), default: nil
+      const :post_code, T.nilable(String), default: nil
+      const :region, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/customer/address_input.rb

@@ -0,0 +1,76 @@
+# 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 Customer
+    # Typed representation of the address input 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] city
+    #   Value of the `city` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `city`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] country
+    #   Value of the `country` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `country`.
+    #   @return [String]
+    #
+    # @!attribute [r] line1
+    #   Value of the `line1` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `line1`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] line2
+    #   Value of the `line2` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `line2`.
+    #   @return [String, nil]
+    #
+    # @!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_number
+    #   Value of the `phone_number` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `phone_number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] post_code
+    #   Value of the `post_code` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `post_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] region
+    #   Value of the `region` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `region`.
+    #   @return [String, nil]
+    class AddressInput < T::Struct
+      const :city, T.nilable(String), default: nil
+      const :country, String
+      const :line1, T.nilable(String), default: nil
+      const :line2, T.nilable(String), default: nil
+      const :name, T.nilable(String), default: nil
+      const :phone_number, T.nilable(String), default: nil
+      const :post_code, T.nilable(String), default: nil
+      const :region, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/customer/balance_value.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 "../money/amount"
+
+module Inttegro
+  class Customer
+    # Typed representation of the balance value 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] as_of
+    #   Value of the `as_of` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `as_of`.
+    #   @return [Time]
+    #
+    # @!attribute [r] available
+    #   Value of the `available` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `available`.
+    #   @return [Inttegro::Money::Amount]
+    class BalanceValue < T::Struct
+      const :as_of, Time
+      const :available, Inttegro::Money::Amount
+    end
+  end
+end

data/lib/inttegro/customer/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require "sorbet-runtime"
+
+module Inttegro
+  class Customer < T::Struct
+  end
+end

data/lib/inttegro/customer/create_request.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 "address_input"
+
+module Inttegro
+  class Customer
+    # Typed representation of the create 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] billing_address
+    #   Value of the `billing_address` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `billing_address`.
+    #   @return [Inttegro::Customer::AddressInput, nil]
+    #
+    # @!attribute [r] custom_data
+    #   Merchant-defined values accepted on resource creation. Values are serialized to strings
+    #   before storage.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
+    #   @return [Hash{String => Object}, nil]
+    #
+    # @!attribute [r] email_address
+    #   Value of the `email_address` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email_address`.
+    #   @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] phone_number
+    #   Value of the `phone_number` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `phone_number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] reference
+    #   Value of the `reference` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `reference`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] shipping_address
+    #   Value of the `shipping_address` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `shipping_address`.
+    #   @return [Inttegro::Customer::AddressInput, nil]
+    #
+    # @!attribute [r] title
+    #   Value of the `title` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `title`.
+    #   @return [String, nil]
+    class CreateRequest < T::Struct
+      const :billing_address, T.nilable(Inttegro::Customer::AddressInput), default: nil
+      const :custom_data, T.nilable(T::Hash[String, Object]), default: nil
+      const :email_address, T.nilable(String), default: nil
+      const :name, String
+      const :phone_number, T.nilable(String), default: nil
+      const :reference, T.nilable(String), default: nil
+      const :shipping_address, T.nilable(Inttegro::Customer::AddressInput), default: nil
+      const :title, T.nilable(String), default: nil
+    end
+  end
+end