trycourier 3.1.4 → 3.4.0.pre.alpha1

data/sig/trycourier/models/users/token_update_params.rbs

@@ -0,0 +1,47 @@
+module Trycourier
+  module Models
+    module Users
+      type token_update_params =
+        {
+          user_id: String,
+          patch: ::Array[Trycourier::Users::TokenUpdateParams::Patch]
+        }
+        & Trycourier::Internal::Type::request_parameters
+
+      class TokenUpdateParams < Trycourier::Internal::Type::BaseModel
+        extend Trycourier::Internal::Type::RequestParameters::Converter
+        include Trycourier::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        attr_accessor patch: ::Array[Trycourier::Users::TokenUpdateParams::Patch]
+
+        def initialize: (
+          user_id: String,
+          patch: ::Array[Trycourier::Users::TokenUpdateParams::Patch],
+          ?request_options: Trycourier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          patch: ::Array[Trycourier::Users::TokenUpdateParams::Patch],
+          request_options: Trycourier::RequestOptions
+        }
+
+        type patch = { op: String, path: String, value: String? }
+
+        class Patch < Trycourier::Internal::Type::BaseModel
+          attr_accessor op: String
+
+          attr_accessor path: String
+
+          attr_accessor value: String?
+
+          def initialize: (op: String, path: String, ?value: String?) -> void
+
+          def to_hash: -> { op: String, path: String, value: String? }
+        end
+      end
+    end
+  end
+end

data/sig/trycourier/models/utm.rbs

@@ -0,0 +1,40 @@
+module Trycourier
+  module Models
+    type utm =
+      {
+        campaign: String?,
+        content: String?,
+        medium: String?,
+        source: String?,
+        term: String?
+      }
+
+    class Utm < Trycourier::Internal::Type::BaseModel
+      attr_accessor campaign: String?
+
+      attr_accessor content: String?
+
+      attr_accessor medium: String?
+
+      attr_accessor source: String?
+
+      attr_accessor term: String?
+
+      def initialize: (
+        ?campaign: String?,
+        ?content: String?,
+        ?medium: String?,
+        ?source: String?,
+        ?term: String?
+      ) -> void
+
+      def to_hash: -> {
+        campaign: String?,
+        content: String?,
+        medium: String?,
+        source: String?,
+        term: String?
+      }
+    end
+  end
+end

data/sig/trycourier/models/widget_background.rbs

@@ -0,0 +1,15 @@
+module Trycourier
+  module Models
+    type widget_background = { bottom_color: String?, top_color: String? }
+
+    class WidgetBackground < Trycourier::Internal::Type::BaseModel
+      attr_accessor bottom_color: String?
+
+      attr_accessor top_color: String?
+
+      def initialize: (?bottom_color: String?, ?top_color: String?) -> void
+
+      def to_hash: -> { bottom_color: String?, top_color: String? }
+    end
+  end
+end

data/sig/trycourier/models.rbs

@@ -0,0 +1,227 @@
+module Trycourier
+  module Alignment = Trycourier::Models::Alignment
+
+  class Audience = Trycourier::Models::Audience
+
+  class AudienceDeleteParams = Trycourier::Models::AudienceDeleteParams
+
+  class AudienceListMembersParams = Trycourier::Models::AudienceListMembersParams
+
+  class AudienceListParams = Trycourier::Models::AudienceListParams
+
+  class AudienceRetrieveParams = Trycourier::Models::AudienceRetrieveParams
+
+  class AudienceUpdateParams = Trycourier::Models::AudienceUpdateParams
+
+  class AuditEvent = Trycourier::Models::AuditEvent
+
+  class AuditEventListParams = Trycourier::Models::AuditEventListParams
+
+  class AuditEventRetrieveParams = Trycourier::Models::AuditEventRetrieveParams
+
+  class AuthIssueTokenParams = Trycourier::Models::AuthIssueTokenParams
+
+  class AutomationInvokeResponse = Trycourier::Models::AutomationInvokeResponse
+
+  module Automations = Trycourier::Models::Automations
+
+  class BaseCheck = Trycourier::Models::BaseCheck
+
+  class BaseTemplateTenantAssociation = Trycourier::Models::BaseTemplateTenantAssociation
+
+  class Brand = Trycourier::Models::Brand
+
+  class BrandColors = Trycourier::Models::BrandColors
+
+  class BrandCreateParams = Trycourier::Models::BrandCreateParams
+
+  class BrandDeleteParams = Trycourier::Models::BrandDeleteParams
+
+  class BrandListParams = Trycourier::Models::BrandListParams
+
+  class BrandRetrieveParams = Trycourier::Models::BrandRetrieveParams
+
+  class BrandSettings = Trycourier::Models::BrandSettings
+
+  class BrandSettingsEmail = Trycourier::Models::BrandSettingsEmail
+
+  class BrandSettingsInApp = Trycourier::Models::BrandSettingsInApp
+
+  class BrandSnippet = Trycourier::Models::BrandSnippet
+
+  class BrandSnippets = Trycourier::Models::BrandSnippets
+
+  class BrandTemplate = Trycourier::Models::BrandTemplate
+
+  class BrandUpdateParams = Trycourier::Models::BrandUpdateParams
+
+  class BulkAddUsersParams = Trycourier::Models::BulkAddUsersParams
+
+  class BulkCreateJobParams = Trycourier::Models::BulkCreateJobParams
+
+  class BulkListUsersParams = Trycourier::Models::BulkListUsersParams
+
+  class BulkRetrieveJobParams = Trycourier::Models::BulkRetrieveJobParams
+
+  class BulkRunJobParams = Trycourier::Models::BulkRunJobParams
+
+  module ChannelClassification = Trycourier::Models::ChannelClassification
+
+  class ChannelPreference = Trycourier::Models::ChannelPreference
+
+  class Check = Trycourier::Models::Check
+
+  class DefaultPreferences = Trycourier::Models::DefaultPreferences
+
+  class ElementalActionNodeWithType = Trycourier::Models::ElementalActionNodeWithType
+
+  class ElementalBaseNode = Trycourier::Models::ElementalBaseNode
+
+  class ElementalChannelNode = Trycourier::Models::ElementalChannelNode
+
+  class ElementalChannelNodeWithType = Trycourier::Models::ElementalChannelNodeWithType
+
+  class ElementalContent = Trycourier::Models::ElementalContent
+
+  class ElementalContentSugar = Trycourier::Models::ElementalContentSugar
+
+  class ElementalDividerNodeWithType = Trycourier::Models::ElementalDividerNodeWithType
+
+  class ElementalImageNodeWithType = Trycourier::Models::ElementalImageNodeWithType
+
+  class ElementalMetaNodeWithType = Trycourier::Models::ElementalMetaNodeWithType
+
+  module ElementalNode = Trycourier::Models::ElementalNode
+
+  class ElementalQuoteNodeWithType = Trycourier::Models::ElementalQuoteNodeWithType
+
+  class ElementalTextNodeWithType = Trycourier::Models::ElementalTextNodeWithType
+
+  class EmailFooter = Trycourier::Models::EmailFooter
+
+  class EmailHead = Trycourier::Models::EmailHead
+
+  class EmailHeader = Trycourier::Models::EmailHeader
+
+  class Filter = Trycourier::Models::Filter
+
+  class FilterConfig = Trycourier::Models::FilterConfig
+
+  class Icons = Trycourier::Models::Icons
+
+  module InboundBulkMessage = Trycourier::Models::InboundBulkMessage
+
+  class InboundBulkMessageUser = Trycourier::Models::InboundBulkMessageUser
+
+  class InboundTrackEventParams = Trycourier::Models::InboundTrackEventParams
+
+  class ListDeleteParams = Trycourier::Models::ListDeleteParams
+
+  class ListListParams = Trycourier::Models::ListListParams
+
+  class ListRestoreParams = Trycourier::Models::ListRestoreParams
+
+  class ListRetrieveParams = Trycourier::Models::ListRetrieveParams
+
+  module Lists = Trycourier::Models::Lists
+
+  class ListUpdateParams = Trycourier::Models::ListUpdateParams
+
+  class Logo = Trycourier::Models::Logo
+
+  class MessageCancelParams = Trycourier::Models::MessageCancelParams
+
+  class MessageContentParams = Trycourier::Models::MessageContentParams
+
+  class MessageContext = Trycourier::Models::MessageContext
+
+  class MessageDetails = Trycourier::Models::MessageDetails
+
+  class MessageHistoryParams = Trycourier::Models::MessageHistoryParams
+
+  class MessageListParams = Trycourier::Models::MessageListParams
+
+  class MessageRetrieveParams = Trycourier::Models::MessageRetrieveParams
+
+  class MessageRouting = Trycourier::Models::MessageRouting
+
+  module MessageRoutingChannel = Trycourier::Models::MessageRoutingChannel
+
+  class NotificationGetContent = Trycourier::Models::NotificationGetContent
+
+  class NotificationListParams = Trycourier::Models::NotificationListParams
+
+  class NotificationPreferenceDetails = Trycourier::Models::NotificationPreferenceDetails
+
+  class NotificationRetrieveContentParams = Trycourier::Models::NotificationRetrieveContentParams
+
+  module Notifications = Trycourier::Models::Notifications
+
+  class Paging = Trycourier::Models::Paging
+
+  class Preference = Trycourier::Models::Preference
+
+  module PreferenceStatus = Trycourier::Models::PreferenceStatus
+
+  class ProfileCreateParams = Trycourier::Models::ProfileCreateParams
+
+  class ProfileDeleteParams = Trycourier::Models::ProfileDeleteParams
+
+  class ProfileReplaceParams = Trycourier::Models::ProfileReplaceParams
+
+  class ProfileRetrieveParams = Trycourier::Models::ProfileRetrieveParams
+
+  module Profiles = Trycourier::Models::Profiles
+
+  class ProfileUpdateParams = Trycourier::Models::ProfileUpdateParams
+
+  class PutSubscriptionsRecipient = Trycourier::Models::PutSubscriptionsRecipient
+
+  class Recipient = Trycourier::Models::Recipient
+
+  class RecipientPreferences = Trycourier::Models::RecipientPreferences
+
+  class RequestArchiveParams = Trycourier::Models::RequestArchiveParams
+
+  class Rule = Trycourier::Models::Rule
+
+  class SendMessageParams = Trycourier::Models::SendMessageParams
+
+  class SubscriptionList = Trycourier::Models::SubscriptionList
+
+  class SubscriptionTopicNew = Trycourier::Models::SubscriptionTopicNew
+
+  class Tenant = Trycourier::Models::Tenant
+
+  class TenantAssociation = Trycourier::Models::TenantAssociation
+
+  class TenantDeleteParams = Trycourier::Models::TenantDeleteParams
+
+  class TenantListParams = Trycourier::Models::TenantListParams
+
+  class TenantListUsersParams = Trycourier::Models::TenantListUsersParams
+
+  class TenantRetrieveParams = Trycourier::Models::TenantRetrieveParams
+
+  module Tenants = Trycourier::Models::Tenants
+
+  class TenantUpdateParams = Trycourier::Models::TenantUpdateParams
+
+  module TextStyle = Trycourier::Models::TextStyle
+
+  class TopicPreference = Trycourier::Models::TopicPreference
+
+  class TranslationRetrieveParams = Trycourier::Models::TranslationRetrieveParams
+
+  class TranslationUpdateParams = Trycourier::Models::TranslationUpdateParams
+
+  class UserRecipient = Trycourier::Models::UserRecipient
+
+  module Users = Trycourier::Models::Users
+
+  class UserToken = Trycourier::Models::UserToken
+
+  class Utm = Trycourier::Models::Utm
+
+  class WidgetBackground = Trycourier::Models::WidgetBackground
+end

data/sig/trycourier/request_options.rbs

@@ -0,0 +1,36 @@
+module Trycourier
+  type request_opts =
+    Trycourier::RequestOptions
+    | Trycourier::request_options
+    | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < Trycourier::Internal::Type::BaseModel
+    def self.validate!: (Trycourier::request_opts opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?Trycourier::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end

data/sig/trycourier/resources/audiences.rbs

@@ -0,0 +1,36 @@
+module Trycourier
+  module Resources
+    class Audiences
+      def retrieve: (
+        String audience_id,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Audience
+
+      def update: (
+        String audience_id,
+        ?description: String?,
+        ?filter: Trycourier::Filter?,
+        ?name: String?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::AudienceUpdateResponse
+
+      def list: (
+        ?cursor: String?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::AudienceListResponse
+
+      def delete: (
+        String audience_id,
+        ?request_options: Trycourier::request_opts
+      ) -> nil
+
+      def list_members: (
+        String audience_id,
+        ?cursor: String?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::AudienceListMembersResponse
+
+      def initialize: (client: Trycourier::Client) -> void
+    end
+  end
+end

data/sig/trycourier/resources/audit_events.rbs

@@ -0,0 +1,17 @@
+module Trycourier
+  module Resources
+    class AuditEvents
+      def retrieve: (
+        String audit_event_id,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::AuditEvent
+
+      def list: (
+        ?cursor: String?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::AuditEventListResponse
+
+      def initialize: (client: Trycourier::Client) -> void
+    end
+  end
+end

data/sig/trycourier/resources/auth.rbs

@@ -0,0 +1,13 @@
+module Trycourier
+  module Resources
+    class Auth
+      def issue_token: (
+        expires_in: String,
+        scope: String,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::AuthIssueTokenResponse
+
+      def initialize: (client: Trycourier::Client) -> void
+    end
+  end
+end

data/sig/trycourier/resources/automations/invoke.rbs

@@ -0,0 +1,29 @@
+module Trycourier
+  module Resources
+    class Automations
+      class Invoke
+        def invoke_ad_hoc: (
+          automation: Trycourier::Automations::InvokeInvokeAdHocParams::Automation,
+          ?brand: String?,
+          ?data: ::Hash[Symbol, top]?,
+          ?profile: ::Hash[Symbol, top]?,
+          ?recipient: String?,
+          ?template: String?,
+          ?request_options: Trycourier::request_opts
+        ) -> Trycourier::AutomationInvokeResponse
+
+        def invoke_by_template: (
+          String template_id,
+          recipient: String?,
+          ?brand: String?,
+          ?data: ::Hash[Symbol, top]?,
+          ?profile: ::Hash[Symbol, top]?,
+          ?template: String?,
+          ?request_options: Trycourier::request_opts
+        ) -> Trycourier::AutomationInvokeResponse
+
+        def initialize: (client: Trycourier::Client) -> void
+      end
+    end
+  end
+end

data/sig/trycourier/resources/automations.rbs

@@ -0,0 +1,9 @@
+module Trycourier
+  module Resources
+    class Automations
+      attr_reader invoke: Trycourier::Resources::Automations::Invoke
+
+      def initialize: (client: Trycourier::Client) -> void
+    end
+  end
+end

data/sig/trycourier/resources/brands.rbs

@@ -0,0 +1,38 @@
+module Trycourier
+  module Resources
+    class Brands
+      def create: (
+        name: String,
+        ?id: String?,
+        ?settings: Trycourier::BrandSettings?,
+        ?snippets: Trycourier::BrandSnippets?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Brand
+
+      def retrieve: (
+        String brand_id,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Brand
+
+      def update: (
+        String brand_id,
+        name: String,
+        ?settings: Trycourier::BrandSettings?,
+        ?snippets: Trycourier::BrandSnippets?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Brand
+
+      def list: (
+        ?cursor: String?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::BrandListResponse
+
+      def delete: (
+        String brand_id,
+        ?request_options: Trycourier::request_opts
+      ) -> nil
+
+      def initialize: (client: Trycourier::Client) -> void
+    end
+  end
+end

data/sig/trycourier/resources/bulk.rbs

@@ -0,0 +1,34 @@
+module Trycourier
+  module Resources
+    class Bulk
+      def add_users: (
+        String job_id,
+        users: ::Array[Trycourier::InboundBulkMessageUser],
+        ?request_options: Trycourier::request_opts
+      ) -> nil
+
+      def create_job: (
+        message: Trycourier::Models::inbound_bulk_message,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::BulkCreateJobResponse
+
+      def list_users: (
+        String job_id,
+        ?cursor: String?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::BulkListUsersResponse
+
+      def retrieve_job: (
+        String job_id,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::BulkRetrieveJobResponse
+
+      def run_job: (
+        String job_id,
+        ?request_options: Trycourier::request_opts
+      ) -> nil
+
+      def initialize: (client: Trycourier::Client) -> void
+    end
+  end
+end

data/sig/trycourier/resources/inbound.rbs

@@ -0,0 +1,16 @@
+module Trycourier
+  module Resources
+    class Inbound
+      def track_event: (
+        event: String,
+        message_id: String,
+        properties: ::Hash[Symbol, top],
+        type: Trycourier::Models::InboundTrackEventParams::type_,
+        ?user_id: String?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::InboundTrackEventResponse
+
+      def initialize: (client: Trycourier::Client) -> void
+    end
+  end
+end

data/sig/trycourier/resources/lists/subscriptions.rbs

@@ -0,0 +1,40 @@
+module Trycourier
+  module Resources
+    class Lists
+      class Subscriptions
+        def list: (
+          String list_id,
+          ?cursor: String?,
+          ?request_options: Trycourier::request_opts
+        ) -> Trycourier::Models::Lists::SubscriptionListResponse
+
+        def add: (
+          String list_id,
+          recipients: ::Array[Trycourier::PutSubscriptionsRecipient],
+          ?request_options: Trycourier::request_opts
+        ) -> nil
+
+        def subscribe: (
+          String list_id,
+          recipients: ::Array[Trycourier::PutSubscriptionsRecipient],
+          ?request_options: Trycourier::request_opts
+        ) -> nil
+
+        def subscribe_user: (
+          String user_id,
+          list_id: String,
+          ?preferences: Trycourier::RecipientPreferences?,
+          ?request_options: Trycourier::request_opts
+        ) -> nil
+
+        def unsubscribe_user: (
+          String user_id,
+          list_id: String,
+          ?request_options: Trycourier::request_opts
+        ) -> nil
+
+        def initialize: (client: Trycourier::Client) -> void
+      end
+    end
+  end
+end

data/sig/trycourier/resources/lists.rbs

@@ -0,0 +1,37 @@
+module Trycourier
+  module Resources
+    class Lists
+      attr_reader subscriptions: Trycourier::Resources::Lists::Subscriptions
+
+      def retrieve: (
+        String list_id,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::SubscriptionList
+
+      def update: (
+        String list_id,
+        name: String,
+        ?preferences: Trycourier::RecipientPreferences?,
+        ?request_options: Trycourier::request_opts
+      ) -> nil
+
+      def list: (
+        ?cursor: String?,
+        ?pattern: String?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::ListListResponse
+
+      def delete: (
+        String list_id,
+        ?request_options: Trycourier::request_opts
+      ) -> nil
+
+      def restore: (
+        String list_id,
+        ?request_options: Trycourier::request_opts
+      ) -> nil
+
+      def initialize: (client: Trycourier::Client) -> void
+    end
+  end
+end

data/sig/trycourier/resources/messages.rbs

@@ -0,0 +1,46 @@
+module Trycourier
+  module Resources
+    class Messages
+      def retrieve: (
+        String message_id,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::MessageRetrieveResponse
+
+      def list: (
+        ?archived: bool?,
+        ?cursor: String?,
+        ?enqueued_after: String?,
+        ?event: String?,
+        ?list: String?,
+        ?message_id: String?,
+        ?notification: String?,
+        ?provider: ::Array[String?],
+        ?recipient: String?,
+        ?status: ::Array[String?],
+        ?tag: ::Array[String?],
+        ?tags: String?,
+        ?tenant_id: String?,
+        ?trace_id: String?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::MessageListResponse
+
+      def cancel: (
+        String message_id,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::MessageDetails
+
+      def content: (
+        String message_id,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::MessageContentResponse
+
+      def history: (
+        String message_id,
+        ?type: String?,
+        ?request_options: Trycourier::request_opts
+      ) -> Trycourier::Models::MessageHistoryResponse
+
+      def initialize: (client: Trycourier::Client) -> void
+    end
+  end
+end