trycourier 4.6.2 → 4.6.3

data/sig/courier/resources/audiences.rbs

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

data/sig/courier/resources/audit_events.rbs

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

data/sig/courier/resources/auth.rbs

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

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

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

data/sig/courier/resources/automations.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Resources
+    class Automations
+      attr_reader invoke: Courier::Resources::Automations::Invoke
+
+      def list: (
+        ?cursor: String,
+        ?version: Courier::Models::AutomationListParams::version,
+        ?request_options: Courier::request_opts
+      ) -> Courier::AutomationTemplateListResponse
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end

data/sig/courier/resources/brands.rbs

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

data/sig/courier/resources/bulk.rbs

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

data/sig/courier/resources/inbound.rbs

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

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

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

data/sig/courier/resources/lists.rbs

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

data/sig/courier/resources/messages.rbs

@@ -0,0 +1,46 @@
+module Courier
+  module Resources
+    class Messages
+      def retrieve: (
+        String message_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::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: Courier::request_opts
+      ) -> Courier::Models::MessageListResponse
+
+      def cancel: (
+        String message_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::MessageDetails
+
+      def content: (
+        String message_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Models::MessageContentResponse
+
+      def history: (
+        String message_id,
+        ?type: String?,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Models::MessageHistoryResponse
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end

data/sig/courier/resources/notifications/checks.rbs

@@ -0,0 +1,28 @@
+module Courier
+  module Resources
+    class Notifications
+      class Checks
+        def update: (
+          String submission_id,
+          id: String,
+          checks: ::Array[Courier::BaseCheck],
+          ?request_options: Courier::request_opts
+        ) -> Courier::Models::Notifications::CheckUpdateResponse
+
+        def list: (
+          String submission_id,
+          id: String,
+          ?request_options: Courier::request_opts
+        ) -> Courier::Models::Notifications::CheckListResponse
+
+        def delete: (
+          String submission_id,
+          id: String,
+          ?request_options: Courier::request_opts
+        ) -> nil
+
+        def initialize: (client: Courier::Client) -> void
+      end
+    end
+  end
+end

data/sig/courier/resources/notifications/draft.rbs

@@ -0,0 +1,14 @@
+module Courier
+  module Resources
+    class Notifications
+      class Draft
+        def retrieve_content: (
+          String id,
+          ?request_options: Courier::request_opts
+        ) -> Courier::NotificationGetContent
+
+        def initialize: (client: Courier::Client) -> void
+      end
+    end
+  end
+end

data/sig/courier/resources/notifications.rbs

@@ -0,0 +1,22 @@
+module Courier
+  module Resources
+    class Notifications
+      attr_reader draft: Courier::Resources::Notifications::Draft
+
+      attr_reader checks: Courier::Resources::Notifications::Checks
+
+      def list: (
+        ?cursor: String?,
+        ?notes: bool?,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Models::NotificationListResponse
+
+      def retrieve_content: (
+        String id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::NotificationGetContent
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end

data/sig/courier/resources/profiles/lists.rbs

@@ -0,0 +1,26 @@
+module Courier
+  module Resources
+    class Profiles
+      class Lists
+        def retrieve: (
+          String user_id,
+          ?cursor: String?,
+          ?request_options: Courier::request_opts
+        ) -> Courier::Models::Profiles::ListRetrieveResponse
+
+        def delete: (
+          String user_id,
+          ?request_options: Courier::request_opts
+        ) -> Courier::Models::Profiles::ListDeleteResponse
+
+        def subscribe: (
+          String user_id,
+          lists: ::Array[Courier::SubscribeToListsRequestItem],
+          ?request_options: Courier::request_opts
+        ) -> Courier::Models::Profiles::ListSubscribeResponse
+
+        def initialize: (client: Courier::Client) -> void
+      end
+    end
+  end
+end

data/sig/courier/resources/profiles.rbs

@@ -0,0 +1,37 @@
+module Courier
+  module Resources
+    class Profiles
+      attr_reader lists: Courier::Resources::Profiles::Lists
+
+      def create: (
+        String user_id,
+        profile: ::Hash[Symbol, top],
+        ?request_options: Courier::request_opts
+      ) -> Courier::Models::ProfileCreateResponse
+
+      def retrieve: (
+        String user_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Models::ProfileRetrieveResponse
+
+      def update: (
+        String user_id,
+        patch: ::Array[Courier::ProfileUpdateParams::Patch],
+        ?request_options: Courier::request_opts
+      ) -> nil
+
+      def delete: (
+        String user_id,
+        ?request_options: Courier::request_opts
+      ) -> nil
+
+      def replace: (
+        String user_id,
+        profile: ::Hash[Symbol, top],
+        ?request_options: Courier::request_opts
+      ) -> Courier::Models::ProfileReplaceResponse
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end

data/sig/courier/resources/requests.rbs

@@ -0,0 +1,12 @@
+module Courier
+  module Resources
+    class Requests
+      def archive: (
+        String request_id,
+        ?request_options: Courier::request_opts
+      ) -> nil
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end

data/sig/courier/resources/send.rbs

@@ -0,0 +1,12 @@
+module Courier
+  module Resources
+    class Send
+      def message: (
+        message: Courier::SendMessageParams::Message,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Models::SendMessageResponse
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end

data/sig/courier/resources/tenants/preferences/items.rbs

@@ -0,0 +1,26 @@
+module Courier
+  module Resources
+    class Tenants
+      class Preferences
+        class Items
+          def update: (
+            String topic_id,
+            tenant_id: String,
+            status: Courier::Models::SubscriptionTopicNew::status,
+            ?custom_routing: ::Array[Courier::Models::channel_classification]?,
+            ?has_custom_routing: bool?,
+            ?request_options: Courier::request_opts
+          ) -> nil
+
+          def delete: (
+            String topic_id,
+            tenant_id: String,
+            ?request_options: Courier::request_opts
+          ) -> nil
+
+          def initialize: (client: Courier::Client) -> void
+        end
+      end
+    end
+  end
+end

data/sig/courier/resources/tenants/preferences.rbs

@@ -0,0 +1,11 @@
+module Courier
+  module Resources
+    class Tenants
+      class Preferences
+        attr_reader items: Courier::Resources::Tenants::Preferences::Items
+
+        def initialize: (client: Courier::Client) -> void
+      end
+    end
+  end
+end

data/sig/courier/resources/tenants/templates.rbs

@@ -0,0 +1,22 @@
+module Courier
+  module Resources
+    class Tenants
+      class Templates
+        def retrieve: (
+          String template_id,
+          tenant_id: String,
+          ?request_options: Courier::request_opts
+        ) -> Courier::BaseTemplateTenantAssociation
+
+        def list: (
+          String tenant_id,
+          ?cursor: String?,
+          ?limit: Integer?,
+          ?request_options: Courier::request_opts
+        ) -> Courier::Models::Tenants::TemplateListResponse
+
+        def initialize: (client: Courier::Client) -> void
+      end
+    end
+  end
+end

data/sig/courier/resources/tenants.rbs

@@ -0,0 +1,46 @@
+module Courier
+  module Resources
+    class Tenants
+      attr_reader preferences: Courier::Resources::Tenants::Preferences
+
+      attr_reader templates: Courier::Resources::Tenants::Templates
+
+      def retrieve: (
+        String tenant_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Tenant
+
+      def update: (
+        String tenant_id,
+        name: String,
+        ?brand_id: String?,
+        ?default_preferences: Courier::DefaultPreferences?,
+        ?parent_tenant_id: String?,
+        ?properties: ::Hash[Symbol, top]?,
+        ?user_profile: ::Hash[Symbol, top]?,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Tenant
+
+      def list: (
+        ?cursor: String?,
+        ?limit: Integer?,
+        ?parent_tenant_id: String?,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Models::TenantListResponse
+
+      def delete: (
+        String tenant_id,
+        ?request_options: Courier::request_opts
+      ) -> nil
+
+      def list_users: (
+        String tenant_id,
+        ?cursor: String?,
+        ?limit: Integer?,
+        ?request_options: Courier::request_opts
+      ) -> Courier::Models::TenantListUsersResponse
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end

data/sig/courier/resources/translations.rbs

@@ -0,0 +1,20 @@
+module Courier
+  module Resources
+    class Translations
+      def retrieve: (
+        String locale,
+        domain: String,
+        ?request_options: Courier::request_opts
+      ) -> String
+
+      def update: (
+        String locale,
+        domain: String,
+        body: String,
+        ?request_options: Courier::request_opts
+      ) -> nil
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end

data/sig/courier/resources/users/preferences.rbs

@@ -0,0 +1,30 @@
+module Courier
+  module Resources
+    class Users
+      class Preferences
+        def retrieve: (
+          String user_id,
+          ?tenant_id: String?,
+          ?request_options: Courier::request_opts
+        ) -> Courier::Models::Users::PreferenceRetrieveResponse
+
+        def retrieve_topic: (
+          String topic_id,
+          user_id: String,
+          ?tenant_id: String?,
+          ?request_options: Courier::request_opts
+        ) -> Courier::Models::Users::PreferenceRetrieveTopicResponse
+
+        def update_or_create_topic: (
+          String topic_id,
+          user_id: String,
+          topic: Courier::Users::PreferenceUpdateOrCreateTopicParams::Topic,
+          ?tenant_id: String?,
+          ?request_options: Courier::request_opts
+        ) -> Courier::Models::Users::PreferenceUpdateOrCreateTopicResponse
+
+        def initialize: (client: Courier::Client) -> void
+      end
+    end
+  end
+end