inttegro 5.0.0 → 6.0.0

data/lib/inttegro/broadcast/cancel_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 "cancel_detail"
+
+module Inttegro
+  module Broadcast
+    # Typed representation of the cancel response 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] broadcast
+    #   Value of the `broadcast` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `broadcast`.
+    #   @return [Inttegro::Broadcast::CancelDetail, nil]
+    class CancelResponse < T::Struct
+      const :broadcast, T.nilable(Inttegro::Broadcast::CancelDetail), default: nil
+    end
+  end
+end

data/lib/inttegro/broadcast/creation_detail.rb

@@ -0,0 +1,91 @@
+# 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/email_message"
+
+module Inttegro
+  module Broadcast
+    # Typed representation of the creation detail 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] content
+    #   Value of the `content` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `content`.
+    #   @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] customer_ids
+    #   Value of the `customer_ids` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `customer_ids`.
+    #   @return [Array<String>, nil]
+    #
+    # @!attribute [r] email
+    #   Email content, safety scan result, and system-generated schema markup for email chimes.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email`.
+    #   @return [Inttegro::Chime::EmailMessage, 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] idempotency_key
+    #   Value of the `idempotency_key` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `idempotency_key`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] purpose
+    #   Value of the `purpose` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `purpose`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] recipients
+    #   Value of the `recipients` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `recipients`.
+    #   @return [Array<String>]
+    #
+    # @!attribute [r] send_after
+    #   Value of the `send_after` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `send_after`.
+    #   @return [Time]
+    #
+    # @!attribute [r] sender_id
+    #   Value of the `sender_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `sender_id`.
+    #   @return [String]
+    class CreationDetail < T::Struct
+      const :content, String
+      const :created_at, Time
+      const :customer_ids, T.nilable(T::Array[String]), default: nil
+      const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
+      const :id, String
+      const :idempotency_key, T.nilable(String), default: nil
+      const :purpose, T.nilable(String), default: nil
+      const :recipients, T::Array[String]
+      const :send_after, Time
+      const :sender_id, String
+    end
+  end
+end

data/lib/inttegro/broadcast/detail.rb

@@ -0,0 +1,113 @@
+# 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/email_message"
+require_relative "error"
+
+module Inttegro
+  module Broadcast
+    # Typed representation of the detail 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] chime_ids
+    #   Value of the `chime_ids` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `chime_ids`.
+    #   @return [Array<String>, nil]
+    #
+    # @!attribute [r] content
+    #   Value of the `content` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `content`.
+    #   @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] customer_ids
+    #   Value of the `customer_ids` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `customer_ids`.
+    #   @return [Array<String>, nil]
+    #
+    # @!attribute [r] email
+    #   Email content, safety scan result, and system-generated schema markup for email chimes.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `email`.
+    #   @return [Inttegro::Chime::EmailMessage, nil]
+    #
+    # @!attribute [r] errors
+    #   Value of the `errors` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `errors`.
+    #   @return [Array<Inttegro::Broadcast::Error>, nil]
+    #
+    # @!attribute [r] executed_at
+    #   Value of the `executed_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `executed_at`.
+    #   @return [Time, 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] idempotency_key
+    #   Value of the `idempotency_key` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `idempotency_key`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] purpose
+    #   Value of the `purpose` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `purpose`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] recipients
+    #   Value of the `recipients` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `recipients`.
+    #   @return [Array<String>]
+    #
+    # @!attribute [r] send_after
+    #   Value of the `send_after` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `send_after`.
+    #   @return [Time]
+    #
+    # @!attribute [r] sender_id
+    #   Value of the `sender_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `sender_id`.
+    #   @return [String]
+    class Detail < T::Struct
+      const :chime_ids, T.nilable(T::Array[String]), default: nil
+      const :content, String
+      const :created_at, Time
+      const :customer_ids, T.nilable(T::Array[String]), default: nil
+      const :email, T.nilable(Inttegro::Chime::EmailMessage), default: nil
+      const :errors, T.nilable(T::Array[Inttegro::Broadcast::Error]), default: nil
+      const :executed_at, T.nilable(Time), default: nil
+      const :id, String
+      const :idempotency_key, T.nilable(String), default: nil
+      const :purpose, T.nilable(String), default: nil
+      const :recipients, T::Array[String]
+      const :send_after, Time
+      const :sender_id, String
+    end
+  end
+end

data/lib/inttegro/broadcast/error.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  module Broadcast
+    # Error encountered when broadcasting to a specific recipient
+    #
+    # 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
+    #   Recipient address that caused the error
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `recipient`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] fix_code
+    #   Code indicating how to fix this error
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `fix_code`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] type
+    #   Error type classification
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `type`.
+    #   @return [String, nil]
+    class Error < T::Struct
+      const :recipient, T.nilable(String), default: nil
+      const :fix_code, T.nilable(String), default: nil
+      const :type, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/broadcast/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
+  module Broadcast
+    # Typed representation of the lookup 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] broadcast_id
+    #   Value of the `broadcast_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `broadcast_id`.
+    #   @return [String]
+    class LookupRequest < T::Struct
+      const :broadcast_id, String
+    end
+  end
+end

data/lib/inttegro/broadcast/lookup_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 "detail"
+
+module Inttegro
+  module Broadcast
+    # Typed representation of the lookup response 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] broadcast
+    #   Value of the `broadcast` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `broadcast`.
+    #   @return [Inttegro::Broadcast::Detail, nil]
+    class LookupResponse < T::Struct
+      const :broadcast, T.nilable(Inttegro::Broadcast::Detail), default: nil
+    end
+  end
+end

data/lib/inttegro/broadcast/request.rb

@@ -0,0 +1,68 @@
+# 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/email_message_input"
+require_relative "../chime/recipient"
+require_relative "../message_template/reference"
+require_relative "request_request_meta"
+
+module Inttegro
+  module Broadcast
+    # Typed representation of the 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] request_meta
+    #   Value of the `request_meta` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `request_meta`.
+    #   @return [Inttegro::Broadcast::RequestRequestMeta, nil]
+    #
+    # @!attribute [r] message_template
+    #   Raw SMS content for SMS broadcasts, or a stored message template reference for SMS or email
+    #   broadcasts.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `message_template`.
+    #   @return [String, Inttegro::MessageTemplate::Reference, 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] purpose
+    #   Category or intent for this broadcast.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `purpose`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] recipients
+    #   Recipient objects for this broadcast. Each item must include `transport` and either inline
+    #   contact details or `customer_id`.
+    #
+    #   Required in the API payload. Wire name: `recipients`.
+    #   @return [Array<Inttegro::Chime::Recipient>]
+    #
+    # @!attribute [r] sender
+    #   Sender identifier displayed to recipients.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sender`.
+    #   @return [String, nil]
+    class Request < T::Struct
+      const :request_meta, T.nilable(Inttegro::Broadcast::RequestRequestMeta), default: nil
+      const :message_template, T.nilable(T.any(String, Inttegro::MessageTemplate::Reference)), default: nil
+      const :email, T.nilable(Inttegro::Chime::EmailMessageInput), default: nil
+      const :purpose, T.nilable(String), default: nil
+      const :recipients, T::Array[Inttegro::Chime::Recipient]
+      const :sender, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/broadcast/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
+  module Broadcast
+    # Typed representation of the request request meta 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] idempotency_key
+    #   Stable retry key. It must match the Idempotency-Key header when both are provided.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `idempotency_key`.
+    #   @return [String, nil]
+    class RequestRequestMeta < T::Struct
+      const :idempotency_key, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/broadcast/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 "creation_detail"
+
+module Inttegro
+  module Broadcast
+    # Typed representation of the response 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] broadcast
+    #   Value of the `broadcast` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `broadcast`.
+    #   @return [Inttegro::Broadcast::CreationDetail, nil]
+    class Response < T::Struct
+      const :broadcast, T.nilable(Inttegro::Broadcast::CreationDetail), default: nil
+    end
+  end
+end

data/lib/inttegro/checkout/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require "sorbet-runtime"
+
+module Inttegro
+  # Namespace for generated checkout models and enums.
+  #
+  # Each public type in this namespace is defined in its own file and follows the field names
+  # and wire values declared by the Inttegro OpenAPI contract.
+  #
+  # @api public
+  module Checkout
+  end
+end

data/lib/inttegro/checkout/billing_details.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 "payment_address"
+
+module Inttegro
+  module Checkout
+    # Typed representation of the billing details 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
+    #   Name of the payer associated with the new payment method.
+    #
+    #   Required in the API payload. Wire name: `name`.
+    #   @return [String]
+    #
+    # @!attribute [r] phone_number
+    #   Phone number associated with the new payment method.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `phone_number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] address
+    #   Value of the `address` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `address`.
+    #   @return [Inttegro::Checkout::PaymentAddress]
+    class BillingDetails < T::Struct
+      const :name, String
+      const :phone_number, T.nilable(String), default: nil
+      const :address, Inttegro::Checkout::PaymentAddress
+    end
+  end
+end

data/lib/inttegro/checkout/confirm_payment_request.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  module Checkout
+    # Typed representation of the confirm payment 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] order_id
+    #   Value of the `order_id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `order_id`.
+    #   @return [String]
+    #
+    # @!attribute [r] payment_id
+    #   Optional payment identifier when already known by the client.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `payment_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] confirmation_id
+    #   Optional confirmation attempt identifier.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `confirmation_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] token
+    #   Payer confirmation token.
+    #
+    #   Required in the API payload. Wire name: `token`.
+    #   @return [String]
+    class ConfirmPaymentRequest < T::Struct
+      const :order_id, String
+      const :payment_id, T.nilable(String), default: nil
+      const :confirmation_id, T.nilable(String), default: nil
+      const :token, String
+    end
+  end
+end

data/lib/inttegro/checkout/invoice_view.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "invoice_view_beneficiary"
+require_relative "invoice_view_format"
+require_relative "invoice_view_status"
+
+module Inttegro
+  module Checkout
+    # Typed representation of the invoice view 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
+    #   Value of the `id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    #
+    # @!attribute [r] application_id
+    #   Value of the `application_id` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `application_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] number
+    #   Value of the `number` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `number`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] status
+    #   Value of the `status` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `status`.
+    #   @return [Inttegro::Checkout::InvoiceViewStatus, 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] due_at
+    #   Value of the `due_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `due_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] format_value
+    #   Value of the `format` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `format`.
+    #   @return [Inttegro::Checkout::InvoiceViewFormat]
+    #
+    # @!attribute [r] beneficiary
+    #   Value of the `beneficiary` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `beneficiary`.
+    #   @return [Inttegro::Checkout::InvoiceViewBeneficiary, nil]
+    class InvoiceView < T::Struct
+      const :id, String
+      const :application_id, T.nilable(String), default: nil
+      const :number, T.nilable(String), default: nil
+      const :status, T.nilable(Inttegro::Checkout::InvoiceViewStatus), default: nil
+      const :created_at, Time
+      const :due_at, T.nilable(Time), default: nil
+      const :format_value, Inttegro::Checkout::InvoiceViewFormat, name: "format"
+      const :beneficiary, T.nilable(Inttegro::Checkout::InvoiceViewBeneficiary), default: nil
+    end
+  end
+end