trycourier 3.1.4 → 3.4.0.pre.alpha0

data/rbi/trycourier/resources/tenants.rbi

@@ -0,0 +1,120 @@
+# typed: strong
+
+module Trycourier
+  module Resources
+    class Tenants
+      sig { returns(Trycourier::Resources::Tenants::DefaultPreferences) }
+      attr_reader :default_preferences
+
+      sig { returns(Trycourier::Resources::Tenants::Templates) }
+      attr_reader :templates
+
+      # Get a Tenant
+      sig do
+        params(
+          tenant_id: String,
+          request_options: Trycourier::RequestOptions::OrHash
+        ).returns(Trycourier::Tenant)
+      end
+      def retrieve(
+        # A unique identifier representing the tenant to be returned.
+        tenant_id,
+        request_options: {}
+      )
+      end
+
+      # Create or Replace a Tenant
+      sig do
+        params(
+          tenant_id: String,
+          name: String,
+          brand_id: T.nilable(String),
+          default_preferences:
+            T.nilable(Trycourier::DefaultPreferences::OrHash),
+          parent_tenant_id: T.nilable(String),
+          properties: T.nilable(T::Hash[Symbol, T.anything]),
+          user_profile: T.nilable(T::Hash[Symbol, T.anything]),
+          request_options: Trycourier::RequestOptions::OrHash
+        ).returns(Trycourier::Tenant)
+      end
+      def update(
+        # A unique identifier representing the tenant to be returned.
+        tenant_id,
+        # Name of the tenant.
+        name:,
+        # Brand to be used for the account when one is not specified by the send call.
+        brand_id: nil,
+        # Defines the preferences used for the tenant when the user hasn't specified their
+        # own.
+        default_preferences: nil,
+        # Tenant's parent id (if any).
+        parent_tenant_id: nil,
+        # Arbitrary properties accessible to a template.
+        properties: nil,
+        # A user profile object merged with user profile on send.
+        user_profile: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a List of Tenants
+      sig do
+        params(
+          cursor: T.nilable(String),
+          limit: T.nilable(Integer),
+          parent_tenant_id: T.nilable(String),
+          request_options: Trycourier::RequestOptions::OrHash
+        ).returns(Trycourier::Models::TenantListResponse)
+      end
+      def list(
+        # Continue the pagination with the next cursor
+        cursor: nil,
+        # The number of tenants to return (defaults to 20, maximum value of 100)
+        limit: nil,
+        # Filter the list of tenants by parent_id
+        parent_tenant_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete a Tenant
+      sig do
+        params(
+          tenant_id: String,
+          request_options: Trycourier::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Id of the tenant to be deleted.
+        tenant_id,
+        request_options: {}
+      )
+      end
+
+      # Get Users in Tenant
+      sig do
+        params(
+          tenant_id: String,
+          cursor: T.nilable(String),
+          limit: T.nilable(Integer),
+          request_options: Trycourier::RequestOptions::OrHash
+        ).returns(Trycourier::Models::TenantListUsersResponse)
+      end
+      def list_users(
+        # Id of the tenant for user membership.
+        tenant_id,
+        # Continue the pagination with the next cursor
+        cursor: nil,
+        # The number of accounts to return (defaults to 20, maximum value of 100)
+        limit: 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/translations.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Trycourier
+  module Resources
+    class Translations
+      # Get translations by locale
+      sig do
+        params(
+          locale: String,
+          domain: String,
+          request_options: Trycourier::RequestOptions::OrHash
+        ).returns(String)
+      end
+      def retrieve(
+        # The locale you want to retrieve the translations for
+        locale,
+        # The domain you want to retrieve translations for. Only `default` is supported at
+        # the moment
+        domain:,
+        request_options: {}
+      )
+      end
+
+      # Update a translation
+      sig do
+        params(
+          locale: String,
+          domain: String,
+          body: String,
+          request_options: Trycourier::RequestOptions::OrHash
+        ).void
+      end
+      def update(
+        # Path param: The locale you want to retrieve the translations for
+        locale,
+        # Path param: The domain you want to retrieve translations for. Only `default` is
+        # supported at the moment
+        domain:,
+        # Body param:
+        body:,
+        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/users/preferences.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module Trycourier
+  module Resources
+    class Users
+      class Preferences
+        # Fetch all user preferences.
+        sig do
+          params(
+            user_id: String,
+            tenant_id: T.nilable(String),
+            request_options: Trycourier::RequestOptions::OrHash
+          ).returns(Trycourier::Models::Users::PreferenceRetrieveResponse)
+        end
+        def retrieve(
+          # A unique identifier associated with the user whose preferences you wish to
+          # retrieve.
+          user_id,
+          # Query the preferences of a user for this specific tenant context.
+          tenant_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Fetch user preferences for a specific subscription topic.
+        sig do
+          params(
+            topic_id: String,
+            user_id: String,
+            tenant_id: T.nilable(String),
+            request_options: Trycourier::RequestOptions::OrHash
+          ).returns(Trycourier::Models::Users::PreferenceRetrieveTopicResponse)
+        end
+        def retrieve_topic(
+          # Path param: A unique identifier associated with a subscription topic.
+          topic_id,
+          # Path param: A unique identifier associated with the user whose preferences you
+          # wish to retrieve.
+          user_id:,
+          # Query param: Query the preferences of a user for this specific tenant context.
+          tenant_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Update or Create user preferences for a specific subscription topic.
+        sig do
+          params(
+            topic_id: String,
+            user_id: String,
+            topic:
+              Trycourier::Users::PreferenceUpdateOrCreateTopicParams::Topic::OrHash,
+            tenant_id: T.nilable(String),
+            request_options: Trycourier::RequestOptions::OrHash
+          ).returns(
+            Trycourier::Models::Users::PreferenceUpdateOrCreateTopicResponse
+          )
+        end
+        def update_or_create_topic(
+          # Path param: A unique identifier associated with a subscription topic.
+          topic_id,
+          # Path param: A unique identifier associated with the user whose preferences you
+          # wish to retrieve.
+          user_id:,
+          # Body param:
+          topic:,
+          # Query param: Update the preferences of a user for this specific tenant context.
+          tenant_id: nil,
+          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/users/tenants.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Trycourier
+  module Resources
+    class Users
+      class Tenants
+        # Returns a paginated list of user tenant associations.
+        sig do
+          params(
+            user_id: String,
+            cursor: T.nilable(String),
+            limit: T.nilable(Integer),
+            request_options: Trycourier::RequestOptions::OrHash
+          ).returns(Trycourier::Models::Users::TenantListResponse)
+        end
+        def list(
+          # Id of the user to retrieve all associated tenants for.
+          user_id,
+          # Continue the pagination with the next cursor
+          cursor: nil,
+          # The number of accounts to return (defaults to 20, maximum value of 100)
+          limit: nil,
+          request_options: {}
+        )
+        end
+
+        # This endpoint is used to add a user to multiple tenants in one call. A custom
+        # profile can also be supplied for each tenant. This profile will be merged with
+        # the user's main profile when sending to the user with that tenant.
+        sig do
+          params(
+            user_id: String,
+            tenants: T::Array[Trycourier::TenantAssociation::OrHash],
+            request_options: Trycourier::RequestOptions::OrHash
+          ).void
+        end
+        def add_multiple(
+          # The user's ID. This can be any uniquely identifiable string.
+          user_id,
+          tenants:,
+          request_options: {}
+        )
+        end
+
+        # This endpoint is used to add a single tenant.
+        #
+        # A custom profile can also be supplied with the tenant. This profile will be
+        # merged with the user's main profile when sending to the user with that tenant.
+        sig do
+          params(
+            tenant_id: String,
+            user_id: String,
+            profile: T.nilable(T::Hash[Symbol, T.anything]),
+            request_options: Trycourier::RequestOptions::OrHash
+          ).void
+        end
+        def add_single(
+          # Path param: Id of the tenant the user should be added to.
+          tenant_id,
+          # Path param: Id of the user to be added to the supplied tenant.
+          user_id:,
+          # Body param:
+          profile: nil,
+          request_options: {}
+        )
+        end
+
+        # Removes a user from any tenants they may have been associated with.
+        sig do
+          params(
+            user_id: String,
+            request_options: Trycourier::RequestOptions::OrHash
+          ).void
+        end
+        def remove_all(
+          # Id of the user to be removed from the supplied tenant.
+          user_id,
+          request_options: {}
+        )
+        end
+
+        # Removes a user from the supplied tenant.
+        sig do
+          params(
+            tenant_id: String,
+            user_id: String,
+            request_options: Trycourier::RequestOptions::OrHash
+          ).void
+        end
+        def remove_single(
+          # Id of the tenant the user should be removed from.
+          tenant_id,
+          # Id of the user to be removed from the supplied tenant.
+          user_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/users/tokens.rbi

@@ -0,0 +1,133 @@
+# typed: strong
+
+module Trycourier
+  module Resources
+    class Users
+      class Tokens
+        # Get single token available for a `:token`
+        sig do
+          params(
+            token: String,
+            user_id: String,
+            request_options: Trycourier::RequestOptions::OrHash
+          ).returns(Trycourier::Models::Users::TokenRetrieveResponse)
+        end
+        def retrieve(
+          # The full token string.
+          token,
+          # The user's ID. This can be any uniquely identifiable string.
+          user_id:,
+          request_options: {}
+        )
+        end
+
+        # Apply a JSON Patch (RFC 6902) to the specified token.
+        sig do
+          params(
+            token: String,
+            user_id: String,
+            patch:
+              T::Array[Trycourier::Users::TokenUpdateParams::Patch::OrHash],
+            request_options: Trycourier::RequestOptions::OrHash
+          ).void
+        end
+        def update(
+          # Path param: The full token string.
+          token,
+          # Path param: The user's ID. This can be any uniquely identifiable string.
+          user_id:,
+          # Body param:
+          patch:,
+          request_options: {}
+        )
+        end
+
+        # Gets all tokens available for a :user_id
+        sig do
+          params(
+            user_id: String,
+            request_options: Trycourier::RequestOptions::OrHash
+          ).returns(T::Array[Trycourier::UserToken])
+        end
+        def list(
+          # The user's ID. This can be any uniquely identifiable string.
+          user_id,
+          request_options: {}
+        )
+        end
+
+        # Delete User Token
+        sig do
+          params(
+            token: String,
+            user_id: String,
+            request_options: Trycourier::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # The full token string.
+          token,
+          # The user's ID. This can be any uniquely identifiable string.
+          user_id:,
+          request_options: {}
+        )
+        end
+
+        # Adds multiple tokens to a user and overwrites matching existing tokens.
+        sig do
+          params(
+            user_id: String,
+            request_options: Trycourier::RequestOptions::OrHash
+          ).void
+        end
+        def add_multiple(
+          # The user's ID. This can be any uniquely identifiable string.
+          user_id,
+          request_options: {}
+        )
+        end
+
+        # Adds a single token to a user and overwrites a matching existing token.
+        sig do
+          params(
+            path_token: String,
+            user_id: String,
+            provider_key: Trycourier::UserToken::ProviderKey::OrSymbol,
+            body_token: T.nilable(String),
+            device: T.nilable(Trycourier::UserToken::Device::OrHash),
+            expiry_date: T.nilable(Trycourier::UserToken::ExpiryDate::Variants),
+            properties: T.anything,
+            tracking: T.nilable(Trycourier::UserToken::Tracking::OrHash),
+            request_options: Trycourier::RequestOptions::OrHash
+          ).void
+        end
+        def add_single(
+          # Path param: The full token string.
+          path_token,
+          # Path param: The user's ID. This can be any uniquely identifiable string.
+          user_id:,
+          # Body param:
+          provider_key:,
+          # Body param: Full body of the token. Must match token in URL.
+          body_token: nil,
+          # Body param: Information about the device the token is associated with.
+          device: nil,
+          # Body param: ISO 8601 formatted date the token expires. Defaults to 2 months. Set
+          # to false to disable expiration.
+          expiry_date: nil,
+          # Body param: Properties sent to the provider along with the token
+          properties: nil,
+          # Body param: Information about the device the token is associated with.
+          tracking: nil,
+          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/users.rbi

@@ -0,0 +1,21 @@
+# typed: strong
+
+module Trycourier
+  module Resources
+    class Users
+      sig { returns(Trycourier::Resources::Users::Preferences) }
+      attr_reader :preferences
+
+      sig { returns(Trycourier::Resources::Users::Tenants) }
+      attr_reader :tenants
+
+      sig { returns(Trycourier::Resources::Users::Tokens) }
+      attr_reader :tokens
+
+      # @api private
+      sig { params(client: Trycourier::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/trycourier/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module Trycourier
+  VERSION = T.let(T.unsafe(nil), String)
+end

data/sig/trycourier/client.rbs

@@ -0,0 +1,56 @@
+module Trycourier
+  class Client < Trycourier::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_key: String
+
+    attr_reader send_: Trycourier::Resources::Send
+
+    attr_reader audiences: Trycourier::Resources::Audiences
+
+    attr_reader audit_events: Trycourier::Resources::AuditEvents
+
+    attr_reader auth: Trycourier::Resources::Auth
+
+    attr_reader automations: Trycourier::Resources::Automations
+
+    attr_reader brands: Trycourier::Resources::Brands
+
+    attr_reader bulk: Trycourier::Resources::Bulk
+
+    attr_reader inbound: Trycourier::Resources::Inbound
+
+    attr_reader lists: Trycourier::Resources::Lists
+
+    attr_reader messages: Trycourier::Resources::Messages
+
+    attr_reader requests: Trycourier::Resources::Requests
+
+    attr_reader notifications: Trycourier::Resources::Notifications
+
+    attr_reader profiles: Trycourier::Resources::Profiles
+
+    attr_reader tenants: Trycourier::Resources::Tenants
+
+    attr_reader translations: Trycourier::Resources::Translations
+
+    attr_reader users: Trycourier::Resources::Users
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_key: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float
+    ) -> void
+  end
+end

data/sig/trycourier/errors.rbs

@@ -0,0 +1,117 @@
+module Trycourier
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < Trycourier::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
+    end
+
+    class APIError < Trycourier::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor headers: ::Hash[String, String]?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < Trycourier::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < Trycourier::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?headers: ::Hash[String, String]?,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < Trycourier::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        headers: ::Hash[String, String]?,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class BadRequestError < Trycourier::Errors::APIStatusError
+      HTTP_STATUS: 400
+    end
+
+    class AuthenticationError < Trycourier::Errors::APIStatusError
+      HTTP_STATUS: 401
+    end
+
+    class PermissionDeniedError < Trycourier::Errors::APIStatusError
+      HTTP_STATUS: 403
+    end
+
+    class NotFoundError < Trycourier::Errors::APIStatusError
+      HTTP_STATUS: 404
+    end
+
+    class ConflictError < Trycourier::Errors::APIStatusError
+      HTTP_STATUS: 409
+    end
+
+    class UnprocessableEntityError < Trycourier::Errors::APIStatusError
+      HTTP_STATUS: 422
+    end
+
+    class RateLimitError < Trycourier::Errors::APIStatusError
+      HTTP_STATUS: 429
+    end
+
+    class InternalServerError < Trycourier::Errors::APIStatusError
+      HTTP_STATUS: Range[Integer]
+    end
+  end
+end