trycourier 4.6.2 → 4.6.3

data/rbi/trycourier/resources/lists.rbi

@@ -1,95 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Resources
-    class Lists
-      sig { returns(Trycourier::Resources::Lists::Subscriptions) }
-      attr_reader :subscriptions
-
-      # Returns a list based on the list ID provided.
-      sig do
-        params(
-          list_id: String,
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::SubscriptionList)
-      end
-      def retrieve(
-        # A unique identifier representing the list you wish to retrieve.
-        list_id,
-        request_options: {}
-      )
-      end
-
-      # Create or replace an existing list with the supplied values.
-      sig do
-        params(
-          list_id: String,
-          name: String,
-          preferences: T.nilable(Trycourier::RecipientPreferences::OrHash),
-          request_options: Trycourier::RequestOptions::OrHash
-        ).void
-      end
-      def update(
-        # A unique identifier representing the list you wish to retrieve.
-        list_id,
-        name:,
-        preferences: nil,
-        request_options: {}
-      )
-      end
-
-      # Returns all of the lists, with the ability to filter based on a pattern.
-      sig do
-        params(
-          cursor: T.nilable(String),
-          pattern: T.nilable(String),
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::Models::ListListResponse)
-      end
-      def list(
-        # A unique identifier that allows for fetching the next page of lists.
-        cursor: nil,
-        # "A pattern used to filter the list items returned. Pattern types supported:
-        # exact match on `list_id` or a pattern of one or more pattern parts. you may
-        # replace a part with either: `*` to match all parts in that position, or `**` to
-        # signify a wildcard `endsWith` pattern match."
-        pattern: nil,
-        request_options: {}
-      )
-      end
-
-      # Delete a list by list ID.
-      sig do
-        params(
-          list_id: String,
-          request_options: Trycourier::RequestOptions::OrHash
-        ).void
-      end
-      def delete(
-        # A unique identifier representing the list you wish to retrieve.
-        list_id,
-        request_options: {}
-      )
-      end
-
-      # Restore a previously deleted list.
-      sig do
-        params(
-          list_id: String,
-          request_options: Trycourier::RequestOptions::OrHash
-        ).void
-      end
-      def restore(
-        # A unique identifier representing the list you wish to retrieve.
-        list_id,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: Trycourier::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/trycourier/resources/messages.rbi

@@ -1,139 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Resources
-    class Messages
-      # Fetch the status of a message you've previously sent.
-      sig do
-        params(
-          message_id: String,
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::Models::MessageRetrieveResponse)
-      end
-      def retrieve(
-        # A unique identifier associated with the message you wish to retrieve (results
-        # from a send).
-        message_id,
-        request_options: {}
-      )
-      end
-
-      # Fetch the statuses of messages you've previously sent.
-      sig do
-        params(
-          archived: T.nilable(T::Boolean),
-          cursor: T.nilable(String),
-          enqueued_after: T.nilable(String),
-          event: T.nilable(String),
-          list: T.nilable(String),
-          message_id: T.nilable(String),
-          notification: T.nilable(String),
-          provider: T::Array[T.nilable(String)],
-          recipient: T.nilable(String),
-          status: T::Array[T.nilable(String)],
-          tag: T::Array[T.nilable(String)],
-          tags: T.nilable(String),
-          tenant_id: T.nilable(String),
-          trace_id: T.nilable(String),
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::Models::MessageListResponse)
-      end
-      def list(
-        # A boolean value that indicates whether archived messages should be included in
-        # the response.
-        archived: nil,
-        # A unique identifier that allows for fetching the next set of messages.
-        cursor: nil,
-        # The enqueued datetime of a message to filter out messages received before.
-        enqueued_after: nil,
-        # A unique identifier representing the event that was used to send the event.
-        event: nil,
-        # A unique identifier representing the list the message was sent to.
-        list: nil,
-        # A unique identifier representing the message_id returned from either /send or
-        # /send/list.
-        message_id: nil,
-        # A unique identifier representing the notification that was used to send the
-        # event.
-        notification: nil,
-        # The key assocated to the provider you want to filter on. E.g., sendgrid, inbox,
-        # twilio, slack, msteams, etc. Allows multiple values to be set in query
-        # parameters.
-        provider: nil,
-        # A unique identifier representing the recipient associated with the requested
-        # profile.
-        recipient: nil,
-        # An indicator of the current status of the message. Allows multiple values to be
-        # set in query parameters.
-        status: nil,
-        # A tag placed in the metadata.tags during a notification send. Allows multiple
-        # values to be set in query parameters.
-        tag: nil,
-        # A comma delimited list of 'tags'. Messages will be returned if they match any of
-        # the tags passed in.
-        tags: nil,
-        # Messages sent with the context of a Tenant
-        tenant_id: nil,
-        # The unique identifier used to trace the requests
-        trace_id: nil,
-        request_options: {}
-      )
-      end
-
-      # Cancel a message that is currently in the process of being delivered. A
-      # well-formatted API call to the cancel message API will return either `200`
-      # status code for a successful cancellation or `409` status code for an
-      # unsuccessful cancellation. Both cases will include the actual message record in
-      # the response body (see details below).
-      sig do
-        params(
-          message_id: String,
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::MessageDetails)
-      end
-      def cancel(
-        # A unique identifier representing the message ID
-        message_id,
-        request_options: {}
-      )
-      end
-
-      # Get message content
-      sig do
-        params(
-          message_id: String,
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::Models::MessageContentResponse)
-      end
-      def content(
-        # A unique identifier associated with the message you wish to retrieve (results
-        # from a send).
-        message_id,
-        request_options: {}
-      )
-      end
-
-      # Fetch the array of events of a message you've previously sent.
-      sig do
-        params(
-          message_id: String,
-          type: T.nilable(String),
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::Models::MessageHistoryResponse)
-      end
-      def history(
-        # A unique identifier representing the message ID
-        message_id,
-        # A supported Message History type that will filter the events returned.
-        type: nil,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: Trycourier::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/trycourier/resources/notifications/checks.rbi

@@ -1,53 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Resources
-    class Notifications
-      class Checks
-        sig do
-          params(
-            submission_id: String,
-            id: String,
-            checks: T::Array[Trycourier::BaseCheck::OrHash],
-            request_options: Trycourier::RequestOptions::OrHash
-          ).returns(Trycourier::Models::Notifications::CheckUpdateResponse)
-        end
-        def update(
-          # Path param
-          submission_id,
-          # Path param
-          id:,
-          # Body param
-          checks:,
-          request_options: {}
-        )
-        end
-
-        sig do
-          params(
-            submission_id: String,
-            id: String,
-            request_options: Trycourier::RequestOptions::OrHash
-          ).returns(Trycourier::Models::Notifications::CheckListResponse)
-        end
-        def list(submission_id, id:, request_options: {})
-        end
-
-        sig do
-          params(
-            submission_id: String,
-            id: String,
-            request_options: Trycourier::RequestOptions::OrHash
-          ).void
-        end
-        def delete(submission_id, id:, request_options: {})
-        end
-
-        # @api private
-        sig { params(client: Trycourier::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
-      end
-    end
-  end
-end

data/rbi/trycourier/resources/notifications/draft.rbi

@@ -1,23 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Resources
-    class Notifications
-      class Draft
-        sig do
-          params(
-            id: String,
-            request_options: Trycourier::RequestOptions::OrHash
-          ).returns(Trycourier::NotificationGetContent)
-        end
-        def retrieve_content(id, request_options: {})
-        end
-
-        # @api private
-        sig { params(client: Trycourier::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
-      end
-    end
-  end
-end

data/rbi/trycourier/resources/notifications.rbi

@@ -1,42 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Resources
-    class Notifications
-      sig { returns(Trycourier::Resources::Notifications::Draft) }
-      attr_reader :draft
-
-      sig { returns(Trycourier::Resources::Notifications::Checks) }
-      attr_reader :checks
-
-      sig do
-        params(
-          cursor: T.nilable(String),
-          notes: T.nilable(T::Boolean),
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::Models::NotificationListResponse)
-      end
-      def list(
-        cursor: nil,
-        # Retrieve the notes from the Notification template settings.
-        notes: nil,
-        request_options: {}
-      )
-      end
-
-      sig do
-        params(
-          id: String,
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::NotificationGetContent)
-      end
-      def retrieve_content(id, request_options: {})
-      end
-
-      # @api private
-      sig { params(client: Trycourier::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/trycourier/resources/profiles/lists.rbi

@@ -1,64 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Resources
-    class Profiles
-      class Lists
-        # Returns the subscribed lists for a specified user.
-        sig do
-          params(
-            user_id: String,
-            cursor: T.nilable(String),
-            request_options: Trycourier::RequestOptions::OrHash
-          ).returns(Trycourier::Models::Profiles::ListRetrieveResponse)
-        end
-        def retrieve(
-          # A unique identifier representing the user associated with the requested user
-          # profile.
-          user_id,
-          # A unique identifier that allows for fetching the next set of message statuses.
-          cursor: nil,
-          request_options: {}
-        )
-        end
-
-        # Removes all list subscriptions for given user.
-        sig do
-          params(
-            user_id: String,
-            request_options: Trycourier::RequestOptions::OrHash
-          ).returns(Trycourier::Models::Profiles::ListDeleteResponse)
-        end
-        def delete(
-          # A unique identifier representing the user associated with the requested profile.
-          user_id,
-          request_options: {}
-        )
-        end
-
-        # Subscribes the given user to one or more lists. If the list does not exist, it
-        # will be created.
-        sig do
-          params(
-            user_id: String,
-            lists: T::Array[Trycourier::SubscribeToListsRequestItem::OrHash],
-            request_options: Trycourier::RequestOptions::OrHash
-          ).returns(Trycourier::Models::Profiles::ListSubscribeResponse)
-        end
-        def subscribe(
-          # A unique identifier representing the user associated with the requested user
-          # profile.
-          user_id,
-          lists:,
-          request_options: {}
-        )
-        end
-
-        # @api private
-        sig { params(client: Trycourier::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
-      end
-    end
-  end
-end

data/rbi/trycourier/resources/profiles.rbi

@@ -1,100 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Resources
-    class Profiles
-      sig { returns(Trycourier::Resources::Profiles::Lists) }
-      attr_reader :lists
-
-      # Merge the supplied values with an existing profile or create a new profile if
-      # one doesn't already exist.
-      sig do
-        params(
-          user_id: String,
-          profile: T::Hash[Symbol, T.anything],
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::Models::ProfileCreateResponse)
-      end
-      def create(
-        # A unique identifier representing the user associated with the requested profile.
-        user_id,
-        profile:,
-        request_options: {}
-      )
-      end
-
-      # Returns the specified user profile.
-      sig do
-        params(
-          user_id: String,
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::Models::ProfileRetrieveResponse)
-      end
-      def retrieve(
-        # A unique identifier representing the user associated with the requested profile.
-        user_id,
-        request_options: {}
-      )
-      end
-
-      # Update a profile
-      sig do
-        params(
-          user_id: String,
-          patch: T::Array[Trycourier::ProfileUpdateParams::Patch::OrHash],
-          request_options: Trycourier::RequestOptions::OrHash
-        ).void
-      end
-      def update(
-        # A unique identifier representing the user associated with the requested user
-        # profile.
-        user_id,
-        # List of patch operations to apply to the profile.
-        patch:,
-        request_options: {}
-      )
-      end
-
-      # Deletes the specified user profile.
-      sig do
-        params(
-          user_id: String,
-          request_options: Trycourier::RequestOptions::OrHash
-        ).void
-      end
-      def delete(
-        # A unique identifier representing the user associated with the requested user
-        # profile.
-        user_id,
-        request_options: {}
-      )
-      end
-
-      # When using `PUT`, be sure to include all the key-value pairs required by the
-      # recipient's profile. Any key-value pairs that exist in the profile but fail to
-      # be included in the `PUT` request will be removed from the profile. Remember, a
-      # `PUT` update is a full replacement of the data. For partial updates, use the
-      # [Patch](https://www.courier.com/docs/reference/profiles/patch/) request.
-      sig do
-        params(
-          user_id: String,
-          profile: T::Hash[Symbol, T.anything],
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::Models::ProfileReplaceResponse)
-      end
-      def replace(
-        # A unique identifier representing the user associated with the requested user
-        # profile.
-        user_id,
-        profile:,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: Trycourier::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/trycourier/resources/requests.rbi

@@ -1,26 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Resources
-    class Requests
-      # Archive message
-      sig do
-        params(
-          request_id: String,
-          request_options: Trycourier::RequestOptions::OrHash
-        ).void
-      end
-      def archive(
-        # A unique identifier representing the request ID
-        request_id,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: Trycourier::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/trycourier/resources/send.rbi

@@ -1,27 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Resources
-    class Send
-      # Send a message to one or more recipients.
-      sig do
-        params(
-          message: Trycourier::SendMessageParams::Message::OrHash,
-          request_options: Trycourier::RequestOptions::OrHash
-        ).returns(Trycourier::Models::SendMessageResponse)
-      end
-      def message(
-        # The message property has the following primary top-level properties. They define
-        # the destination and content of the message.
-        message:,
-        request_options: {}
-      )
-      end
-
-      # @api private
-      sig { params(client: Trycourier::Client).returns(T.attached_class) }
-      def self.new(client:)
-      end
-    end
-  end
-end

data/rbi/trycourier/resources/tenants/preferences/items.rbi

@@ -1,66 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Resources
-    class Tenants
-      class Preferences
-        class Items
-          # Create or Replace Default Preferences For Topic
-          sig do
-            params(
-              topic_id: String,
-              tenant_id: String,
-              status: Trycourier::SubscriptionTopicNew::Status::OrSymbol,
-              custom_routing:
-                T.nilable(
-                  T::Array[Trycourier::ChannelClassification::OrSymbol]
-                ),
-              has_custom_routing: T.nilable(T::Boolean),
-              request_options: Trycourier::RequestOptions::OrHash
-            ).void
-          end
-          def update(
-            # Path param: Id of the subscription topic you want to have a default preference
-            # for.
-            topic_id,
-            # Path param: Id of the tenant to update the default preferences for.
-            tenant_id:,
-            # Body param
-            status:,
-            # Body param: The default channels to send to this tenant when has_custom_routing
-            # is enabled
-            custom_routing: nil,
-            # Body param: Override channel routing with custom preferences. This will override
-            # any template preferences that are set, but a user can still customize their
-            # preferences
-            has_custom_routing: nil,
-            request_options: {}
-          )
-          end
-
-          # Remove Default Preferences For Topic
-          sig do
-            params(
-              topic_id: String,
-              tenant_id: String,
-              request_options: Trycourier::RequestOptions::OrHash
-            ).void
-          end
-          def delete(
-            # Id of the subscription topic you want to have a default preference for.
-            topic_id,
-            # Id of the tenant to update the default preferences for.
-            tenant_id:,
-            request_options: {}
-          )
-          end
-
-          # @api private
-          sig { params(client: Trycourier::Client).returns(T.attached_class) }
-          def self.new(client:)
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/trycourier/resources/tenants/preferences.rbi

@@ -1,17 +0,0 @@
-# typed: strong
-
-module Trycourier
-  module Resources
-    class Tenants
-      class Preferences
-        sig { returns(Trycourier::Resources::Tenants::Preferences::Items) }
-        attr_reader :items
-
-        # @api private
-        sig { params(client: Trycourier::Client).returns(T.attached_class) }
-        def self.new(client:)
-        end
-      end
-    end
-  end
-end