trycourier 4.3.0 → 4.5.0

data/lib/trycourier/models/recipient.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Models
-    class Recipient < Trycourier::Internal::Type::BaseModel
-      # @!attribute account_id
-      #   Deprecated - Use `tenant_id` instead.
-      #
-      #   @return [String, nil]
-      optional :account_id, String, nil?: true
-
-      # @!attribute context
-      #   Context such as tenant_id to send the notification with.
-      #
-      #   @return [Trycourier::Models::MessageContext, nil]
-      optional :context, -> { Trycourier::MessageContext }, nil?: true
-
-      # @!attribute data
-      #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :data, Trycourier::Internal::Type::HashOf[Trycourier::Internal::Type::Unknown], nil?: true
-
-      # @!attribute email
-      #   The user's email address.
-      #
-      #   @return [String, nil]
-      optional :email, String, nil?: true
-
-      # @!attribute list_id
-      #   The id of the list to send the message to.
-      #
-      #   @return [String, nil]
-      optional :list_id, String, nil?: true
-
-      # @!attribute locale
-      #   The user's preferred ISO 639-1 language code.
-      #
-      #   @return [String, nil]
-      optional :locale, String, nil?: true
-
-      # @!attribute phone_number
-      #   The user's phone number.
-      #
-      #   @return [String, nil]
-      optional :phone_number, String, nil?: true
-
-      # @!attribute preferences
-      #
-      #   @return [Trycourier::Models::Recipient::Preferences, nil]
-      optional :preferences, -> { Trycourier::Recipient::Preferences }, nil?: true
-
-      # @!attribute tenant_id
-      #   The id of the tenant the user is associated with.
-      #
-      #   @return [String, nil]
-      optional :tenant_id, String, nil?: true
-
-      # @!attribute user_id
-      #   The user's unique identifier. Typically, this will match the user id of a user
-      #   in your system.
-      #
-      #   @return [String, nil]
-      optional :user_id, String, nil?: true
-
-      # @!method initialize(account_id: nil, context: nil, data: nil, email: nil, list_id: nil, locale: nil, phone_number: nil, preferences: nil, tenant_id: nil, user_id: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Trycourier::Models::Recipient} for more details.
-      #
-      #   @param account_id [String, nil] Deprecated - Use `tenant_id` instead.
-      #
-      #   @param context [Trycourier::Models::MessageContext, nil] Context such as tenant_id to send the notification with.
-      #
-      #   @param data [Hash{Symbol=>Object}, nil]
-      #
-      #   @param email [String, nil] The user's email address.
-      #
-      #   @param list_id [String, nil] The id of the list to send the message to.
-      #
-      #   @param locale [String, nil] The user's preferred ISO 639-1 language code.
-      #
-      #   @param phone_number [String, nil] The user's phone number.
-      #
-      #   @param preferences [Trycourier::Models::Recipient::Preferences, nil]
-      #
-      #   @param tenant_id [String, nil] The id of the tenant the user is associated with.
-      #
-      #   @param user_id [String, nil] The user's unique identifier. Typically, this will match the user id of a user i
-
-      # @see Trycourier::Models::Recipient#preferences
-      class Preferences < Trycourier::Internal::Type::BaseModel
-        # @!attribute notifications
-        #
-        #   @return [Hash{Symbol=>Trycourier::Models::Preference}]
-        required :notifications, -> { Trycourier::Internal::Type::HashOf[Trycourier::Preference] }
-
-        # @!attribute categories
-        #
-        #   @return [Hash{Symbol=>Trycourier::Models::Preference}, nil]
-        optional :categories, -> { Trycourier::Internal::Type::HashOf[Trycourier::Preference] }, nil?: true
-
-        # @!attribute template_id
-        #
-        #   @return [String, nil]
-        optional :template_id, String, api_name: :templateId, nil?: true
-
-        # @!method initialize(notifications:, categories: nil, template_id: nil)
-        #   @param notifications [Hash{Symbol=>Trycourier::Models::Preference}]
-        #   @param categories [Hash{Symbol=>Trycourier::Models::Preference}, nil]
-        #   @param template_id [String, nil]
-      end
-    end
-  end
-end

data/rbi/trycourier/models/recipient.rbi

@@ -1,161 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Models
-    class Recipient < Trycourier::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias do
-          T.any(Trycourier::Recipient, Trycourier::Internal::AnyHash)
-        end
-
-      # Deprecated - Use `tenant_id` instead.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :account_id
-
-      # Context such as tenant_id to send the notification with.
-      sig { returns(T.nilable(Trycourier::MessageContext)) }
-      attr_reader :context
-
-      sig do
-        params(context: T.nilable(Trycourier::MessageContext::OrHash)).void
-      end
-      attr_writer :context
-
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-      attr_accessor :data
-
-      # The user's email address.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :email
-
-      # The id of the list to send the message to.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :list_id
-
-      # The user's preferred ISO 639-1 language code.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :locale
-
-      # The user's phone number.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :phone_number
-
-      sig { returns(T.nilable(Trycourier::Recipient::Preferences)) }
-      attr_reader :preferences
-
-      sig do
-        params(
-          preferences: T.nilable(Trycourier::Recipient::Preferences::OrHash)
-        ).void
-      end
-      attr_writer :preferences
-
-      # The id of the tenant the user is associated with.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :tenant_id
-
-      # The user's unique identifier. Typically, this will match the user id of a user
-      # in your system.
-      sig { returns(T.nilable(String)) }
-      attr_accessor :user_id
-
-      sig do
-        params(
-          account_id: T.nilable(String),
-          context: T.nilable(Trycourier::MessageContext::OrHash),
-          data: T.nilable(T::Hash[Symbol, T.anything]),
-          email: T.nilable(String),
-          list_id: T.nilable(String),
-          locale: T.nilable(String),
-          phone_number: T.nilable(String),
-          preferences: T.nilable(Trycourier::Recipient::Preferences::OrHash),
-          tenant_id: T.nilable(String),
-          user_id: T.nilable(String)
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # Deprecated - Use `tenant_id` instead.
-        account_id: nil,
-        # Context such as tenant_id to send the notification with.
-        context: nil,
-        data: nil,
-        # The user's email address.
-        email: nil,
-        # The id of the list to send the message to.
-        list_id: nil,
-        # The user's preferred ISO 639-1 language code.
-        locale: nil,
-        # The user's phone number.
-        phone_number: nil,
-        preferences: nil,
-        # The id of the tenant the user is associated with.
-        tenant_id: nil,
-        # The user's unique identifier. Typically, this will match the user id of a user
-        # in your system.
-        user_id: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            account_id: T.nilable(String),
-            context: T.nilable(Trycourier::MessageContext),
-            data: T.nilable(T::Hash[Symbol, T.anything]),
-            email: T.nilable(String),
-            list_id: T.nilable(String),
-            locale: T.nilable(String),
-            phone_number: T.nilable(String),
-            preferences: T.nilable(Trycourier::Recipient::Preferences),
-            tenant_id: T.nilable(String),
-            user_id: T.nilable(String)
-          }
-        )
-      end
-      def to_hash
-      end
-
-      class Preferences < Trycourier::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Trycourier::Recipient::Preferences,
-              Trycourier::Internal::AnyHash
-            )
-          end
-
-        sig { returns(T::Hash[Symbol, Trycourier::Preference]) }
-        attr_accessor :notifications
-
-        sig { returns(T.nilable(T::Hash[Symbol, Trycourier::Preference])) }
-        attr_accessor :categories
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :template_id
-
-        sig do
-          params(
-            notifications: T::Hash[Symbol, Trycourier::Preference::OrHash],
-            categories:
-              T.nilable(T::Hash[Symbol, Trycourier::Preference::OrHash]),
-            template_id: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(notifications:, categories: nil, template_id: nil)
-        end
-
-        sig do
-          override.returns(
-            {
-              notifications: T::Hash[Symbol, Trycourier::Preference],
-              categories: T.nilable(T::Hash[Symbol, Trycourier::Preference]),
-              template_id: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/sig/trycourier/models/recipient.rbs

@@ -1,92 +0,0 @@
-module Trycourier
-  module Models
-    type recipient =
-      {
-        account_id: String?,
-        context: Trycourier::MessageContext?,
-        data: ::Hash[Symbol, top]?,
-        email: String?,
-        list_id: String?,
-        locale: String?,
-        phone_number: String?,
-        preferences: Trycourier::Recipient::Preferences?,
-        tenant_id: String?,
-        user_id: String?
-      }
-
-    class Recipient < Trycourier::Internal::Type::BaseModel
-      attr_accessor account_id: String?
-
-      attr_accessor context: Trycourier::MessageContext?
-
-      attr_accessor data: ::Hash[Symbol, top]?
-
-      attr_accessor email: String?
-
-      attr_accessor list_id: String?
-
-      attr_accessor locale: String?
-
-      attr_accessor phone_number: String?
-
-      attr_accessor preferences: Trycourier::Recipient::Preferences?
-
-      attr_accessor tenant_id: String?
-
-      attr_accessor user_id: String?
-
-      def initialize: (
-        ?account_id: String?,
-        ?context: Trycourier::MessageContext?,
-        ?data: ::Hash[Symbol, top]?,
-        ?email: String?,
-        ?list_id: String?,
-        ?locale: String?,
-        ?phone_number: String?,
-        ?preferences: Trycourier::Recipient::Preferences?,
-        ?tenant_id: String?,
-        ?user_id: String?
-      ) -> void
-
-      def to_hash: -> {
-        account_id: String?,
-        context: Trycourier::MessageContext?,
-        data: ::Hash[Symbol, top]?,
-        email: String?,
-        list_id: String?,
-        locale: String?,
-        phone_number: String?,
-        preferences: Trycourier::Recipient::Preferences?,
-        tenant_id: String?,
-        user_id: String?
-      }
-
-      type preferences =
-        {
-          notifications: ::Hash[Symbol, Trycourier::Preference],
-          categories: ::Hash[Symbol, Trycourier::Preference]?,
-          template_id: String?
-        }
-
-      class Preferences < Trycourier::Internal::Type::BaseModel
-        attr_accessor notifications: ::Hash[Symbol, Trycourier::Preference]
-
-        attr_accessor categories: ::Hash[Symbol, Trycourier::Preference]?
-
-        attr_accessor template_id: String?
-
-        def initialize: (
-          notifications: ::Hash[Symbol, Trycourier::Preference],
-          ?categories: ::Hash[Symbol, Trycourier::Preference]?,
-          ?template_id: String?
-        ) -> void
-
-        def to_hash: -> {
-          notifications: ::Hash[Symbol, Trycourier::Preference],
-          categories: ::Hash[Symbol, Trycourier::Preference]?,
-          template_id: String?
-        }
-      end
-    end
-  end
-end