trycourier 4.4.0 → 4.5.0

data/rbi/trycourier/models/user_profile.rbi

@@ -0,0 +1,377 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class UserProfile < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::UserProfile, Trycourier::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Trycourier::UserProfile::Address)) }
+      attr_reader :address
+
+      sig do
+        params(
+          address: T.nilable(Trycourier::UserProfile::Address::OrHash)
+        ).void
+      end
+      attr_writer :address
+
+      sig { returns(T.nilable(Trycourier::AirshipProfile)) }
+      attr_reader :airship
+
+      sig do
+        params(airship: T.nilable(Trycourier::AirshipProfile::OrHash)).void
+      end
+      attr_writer :airship
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :apn
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :birthdate
+
+      # A free form object. Due to a limitation of the API Explorer, you can only enter
+      # string key/values below, but this API accepts more complex object structures.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :custom
+
+      sig do
+        returns(
+          T.nilable(
+            T.any(Trycourier::SendToChannel, Trycourier::SendDirectMessage)
+          )
+        )
+      end
+      attr_accessor :discord
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :email_verified
+
+      sig do
+        returns(T.nilable(T.any(Trycourier::Token, Trycourier::MultipleTokens)))
+      end
+      attr_accessor :expo
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :facebook_psid
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :family_name
+
+      sig { returns(T.nilable(Trycourier::UserProfileFirebaseToken::Variants)) }
+      attr_accessor :firebase_token
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :gender
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :given_name
+
+      sig { returns(T.nilable(Trycourier::Intercom)) }
+      attr_reader :intercom
+
+      sig { params(intercom: T.nilable(Trycourier::Intercom::OrHash)).void }
+      attr_writer :intercom
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :locale
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :middle_name
+
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              Trycourier::SendToMsTeamsUserID,
+              Trycourier::SendToMsTeamsEmail,
+              Trycourier::SendToMsTeamsChannelID,
+              Trycourier::SendToMsTeamsConversationID,
+              Trycourier::SendToMsTeamsChannelName
+            )
+          )
+        )
+      end
+      attr_accessor :ms_teams
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :nickname
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_number
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :phone_number_verified
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :picture
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :preferred_name
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :profile
+
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              Trycourier::SendToSlackChannel,
+              Trycourier::SendToSlackEmail,
+              Trycourier::SendToSlackUserID
+            )
+          )
+        )
+      end
+      attr_accessor :slack
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :sub
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :target_arn
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :updated_at
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :website
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :zoneinfo
+
+      sig do
+        params(
+          address: T.nilable(Trycourier::UserProfile::Address::OrHash),
+          airship: T.nilable(Trycourier::AirshipProfile::OrHash),
+          apn: T.nilable(String),
+          birthdate: T.nilable(String),
+          custom: T.nilable(T::Hash[Symbol, T.anything]),
+          discord:
+            T.nilable(
+              T.any(
+                Trycourier::SendToChannel::OrHash,
+                Trycourier::SendDirectMessage::OrHash
+              )
+            ),
+          email: T.nilable(String),
+          email_verified: T.nilable(T::Boolean),
+          expo:
+            T.nilable(
+              T.any(
+                Trycourier::Token::OrHash,
+                Trycourier::MultipleTokens::OrHash
+              )
+            ),
+          facebook_psid: T.nilable(String),
+          family_name: T.nilable(String),
+          firebase_token:
+            T.nilable(Trycourier::UserProfileFirebaseToken::Variants),
+          gender: T.nilable(String),
+          given_name: T.nilable(String),
+          intercom: T.nilable(Trycourier::Intercom::OrHash),
+          locale: T.nilable(String),
+          middle_name: T.nilable(String),
+          ms_teams:
+            T.nilable(
+              T.any(
+                Trycourier::SendToMsTeamsUserID::OrHash,
+                Trycourier::SendToMsTeamsEmail::OrHash,
+                Trycourier::SendToMsTeamsChannelID::OrHash,
+                Trycourier::SendToMsTeamsConversationID::OrHash,
+                Trycourier::SendToMsTeamsChannelName::OrHash
+              )
+            ),
+          name: T.nilable(String),
+          nickname: T.nilable(String),
+          phone_number: T.nilable(String),
+          phone_number_verified: T.nilable(T::Boolean),
+          picture: T.nilable(String),
+          preferred_name: T.nilable(String),
+          profile: T.nilable(String),
+          slack:
+            T.nilable(
+              T.any(
+                Trycourier::SendToSlackChannel::OrHash,
+                Trycourier::SendToSlackEmail::OrHash,
+                Trycourier::SendToSlackUserID::OrHash
+              )
+            ),
+          sub: T.nilable(String),
+          target_arn: T.nilable(String),
+          updated_at: T.nilable(String),
+          website: T.nilable(String),
+          zoneinfo: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        address: nil,
+        airship: nil,
+        apn: nil,
+        birthdate: nil,
+        # A free form object. Due to a limitation of the API Explorer, you can only enter
+        # string key/values below, but this API accepts more complex object structures.
+        custom: nil,
+        discord: nil,
+        email: nil,
+        email_verified: nil,
+        expo: nil,
+        facebook_psid: nil,
+        family_name: nil,
+        firebase_token: nil,
+        gender: nil,
+        given_name: nil,
+        intercom: nil,
+        locale: nil,
+        middle_name: nil,
+        ms_teams: nil,
+        name: nil,
+        nickname: nil,
+        phone_number: nil,
+        phone_number_verified: nil,
+        picture: nil,
+        preferred_name: nil,
+        profile: nil,
+        slack: nil,
+        sub: nil,
+        target_arn: nil,
+        updated_at: nil,
+        website: nil,
+        zoneinfo: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            address: T.nilable(Trycourier::UserProfile::Address),
+            airship: T.nilable(Trycourier::AirshipProfile),
+            apn: T.nilable(String),
+            birthdate: T.nilable(String),
+            custom: T.nilable(T::Hash[Symbol, T.anything]),
+            discord:
+              T.nilable(
+                T.any(Trycourier::SendToChannel, Trycourier::SendDirectMessage)
+              ),
+            email: T.nilable(String),
+            email_verified: T.nilable(T::Boolean),
+            expo:
+              T.nilable(T.any(Trycourier::Token, Trycourier::MultipleTokens)),
+            facebook_psid: T.nilable(String),
+            family_name: T.nilable(String),
+            firebase_token:
+              T.nilable(Trycourier::UserProfileFirebaseToken::Variants),
+            gender: T.nilable(String),
+            given_name: T.nilable(String),
+            intercom: T.nilable(Trycourier::Intercom),
+            locale: T.nilable(String),
+            middle_name: T.nilable(String),
+            ms_teams:
+              T.nilable(
+                T.any(
+                  Trycourier::SendToMsTeamsUserID,
+                  Trycourier::SendToMsTeamsEmail,
+                  Trycourier::SendToMsTeamsChannelID,
+                  Trycourier::SendToMsTeamsConversationID,
+                  Trycourier::SendToMsTeamsChannelName
+                )
+              ),
+            name: T.nilable(String),
+            nickname: T.nilable(String),
+            phone_number: T.nilable(String),
+            phone_number_verified: T.nilable(T::Boolean),
+            picture: T.nilable(String),
+            preferred_name: T.nilable(String),
+            profile: T.nilable(String),
+            slack:
+              T.nilable(
+                T.any(
+                  Trycourier::SendToSlackChannel,
+                  Trycourier::SendToSlackEmail,
+                  Trycourier::SendToSlackUserID
+                )
+              ),
+            sub: T.nilable(String),
+            target_arn: T.nilable(String),
+            updated_at: T.nilable(String),
+            website: T.nilable(String),
+            zoneinfo: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Address < Trycourier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Trycourier::UserProfile::Address,
+              Trycourier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :country
+
+        sig { returns(String) }
+        attr_accessor :formatted
+
+        sig { returns(String) }
+        attr_accessor :locality
+
+        sig { returns(String) }
+        attr_accessor :postal_code
+
+        sig { returns(String) }
+        attr_accessor :region
+
+        sig { returns(String) }
+        attr_accessor :street_address
+
+        sig do
+          params(
+            country: String,
+            formatted: String,
+            locality: String,
+            postal_code: String,
+            region: String,
+            street_address: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          country:,
+          formatted:,
+          locality:,
+          postal_code:,
+          region:,
+          street_address:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              country: String,
+              formatted: String,
+              locality: String,
+              postal_code: String,
+              region: String,
+              street_address: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/trycourier/models/user_profile_firebase_token.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    module UserProfileFirebaseToken
+      extend Trycourier::Internal::Type::Union
+
+      Variants = T.type_alias { T.any(String, T::Array[String]) }
+
+      sig do
+        override.returns(
+          T::Array[Trycourier::UserProfileFirebaseToken::Variants]
+        )
+      end
+      def self.variants
+      end
+
+      StringArray =
+        T.let(
+          Trycourier::Internal::Type::ArrayOf[String],
+          Trycourier::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/trycourier/models/webhook_auth_mode.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    module WebhookAuthMode
+      extend Trycourier::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Trycourier::WebhookAuthMode) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      NONE = T.let(:none, Trycourier::WebhookAuthMode::TaggedSymbol)
+      BASIC = T.let(:basic, Trycourier::WebhookAuthMode::TaggedSymbol)
+      BEARER = T.let(:bearer, Trycourier::WebhookAuthMode::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Trycourier::WebhookAuthMode::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/trycourier/models/webhook_authentication.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class WebhookAuthentication < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Trycourier::WebhookAuthentication,
+            Trycourier::Internal::AnyHash
+          )
+        end
+
+      # The authentication mode to use. Defaults to 'none' if not specified.
+      sig { returns(Trycourier::WebhookAuthMode::OrSymbol) }
+      attr_accessor :mode
+
+      # Token for bearer authentication.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :token
+
+      # Password for basic authentication.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :password
+
+      # Username for basic authentication.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :username
+
+      sig do
+        params(
+          mode: Trycourier::WebhookAuthMode::OrSymbol,
+          token: T.nilable(String),
+          password: T.nilable(String),
+          username: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The authentication mode to use. Defaults to 'none' if not specified.
+        mode:,
+        # Token for bearer authentication.
+        token: nil,
+        # Password for basic authentication.
+        password: nil,
+        # Username for basic authentication.
+        username: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            mode: Trycourier::WebhookAuthMode::OrSymbol,
+            token: T.nilable(String),
+            password: T.nilable(String),
+            username: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/trycourier/models/webhook_method.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    module WebhookMethod
+      extend Trycourier::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Trycourier::WebhookMethod) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      POST = T.let(:POST, Trycourier::WebhookMethod::TaggedSymbol)
+      PUT = T.let(:PUT, Trycourier::WebhookMethod::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Trycourier::WebhookMethod::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/trycourier/models/webhook_profile.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class WebhookProfile < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::WebhookProfile, Trycourier::Internal::AnyHash)
+        end
+
+      # The URL to send the webhook request to.
+      sig { returns(String) }
+      attr_accessor :url
+
+      # Authentication configuration for the webhook request.
+      sig { returns(T.nilable(Trycourier::WebhookAuthentication)) }
+      attr_reader :authentication
+
+      sig do
+        params(
+          authentication: T.nilable(Trycourier::WebhookAuthentication::OrHash)
+        ).void
+      end
+      attr_writer :authentication
+
+      # Custom headers to include in the webhook request.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :headers
+
+      # The HTTP method to use for the webhook request. Defaults to POST if not
+      # specified.
+      sig { returns(T.nilable(Trycourier::WebhookMethod::OrSymbol)) }
+      attr_accessor :method_
+
+      # Specifies what profile information is included in the request payload. Defaults
+      # to 'limited' if not specified.
+      sig { returns(T.nilable(Trycourier::WebhookProfileType::OrSymbol)) }
+      attr_accessor :profile
+
+      sig do
+        params(
+          url: String,
+          authentication: T.nilable(Trycourier::WebhookAuthentication::OrHash),
+          headers: T.nilable(T::Hash[Symbol, String]),
+          method_: T.nilable(Trycourier::WebhookMethod::OrSymbol),
+          profile: T.nilable(Trycourier::WebhookProfileType::OrSymbol)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The URL to send the webhook request to.
+        url:,
+        # Authentication configuration for the webhook request.
+        authentication: nil,
+        # Custom headers to include in the webhook request.
+        headers: nil,
+        # The HTTP method to use for the webhook request. Defaults to POST if not
+        # specified.
+        method_: nil,
+        # Specifies what profile information is included in the request payload. Defaults
+        # to 'limited' if not specified.
+        profile: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            url: String,
+            authentication: T.nilable(Trycourier::WebhookAuthentication),
+            headers: T.nilable(T::Hash[Symbol, String]),
+            method_: T.nilable(Trycourier::WebhookMethod::OrSymbol),
+            profile: T.nilable(Trycourier::WebhookProfileType::OrSymbol)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/trycourier/models/webhook_profile_type.rbi

@@ -0,0 +1,22 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    module WebhookProfileType
+      extend Trycourier::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Trycourier::WebhookProfileType) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      LIMITED = T.let(:limited, Trycourier::WebhookProfileType::TaggedSymbol)
+      EXPANDED = T.let(:expanded, Trycourier::WebhookProfileType::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Trycourier::WebhookProfileType::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/trycourier/models/webhook_recipient.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Trycourier
+  module Models
+    class WebhookRecipient < Trycourier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Trycourier::WebhookRecipient, Trycourier::Internal::AnyHash)
+        end
+
+      sig { returns(Trycourier::WebhookProfile) }
+      attr_reader :webhook
+
+      sig { params(webhook: Trycourier::WebhookProfile::OrHash).void }
+      attr_writer :webhook
+
+      # Send via webhook
+      sig do
+        params(webhook: Trycourier::WebhookProfile::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(webhook:)
+      end
+
+      sig { override.returns({ webhook: Trycourier::WebhookProfile }) }
+      def to_hash
+      end
+    end
+  end
+end