trycourier 4.6.2 → 4.6.3

data/sig/courier/models/automations/invoke_invoke_ad_hoc_params.rbs

@@ -0,0 +1,435 @@
+module Courier
+  module Models
+    module Automations
+      type invoke_invoke_ad_hoc_params =
+        {
+          automation: Courier::Automations::InvokeInvokeAdHocParams::Automation,
+          brand: String?,
+          data: ::Hash[Symbol, top]?,
+          profile: ::Hash[Symbol, top]?,
+          recipient: String?,
+          template: String?
+        }
+        & Courier::Internal::Type::request_parameters
+
+      class InvokeInvokeAdHocParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        attr_accessor automation: Courier::Automations::InvokeInvokeAdHocParams::Automation
+
+        attr_accessor brand: String?
+
+        attr_accessor data: ::Hash[Symbol, top]?
+
+        attr_accessor profile: ::Hash[Symbol, top]?
+
+        attr_accessor recipient: String?
+
+        attr_accessor template: String?
+
+        def initialize: (
+          automation: Courier::Automations::InvokeInvokeAdHocParams::Automation,
+          ?brand: String?,
+          ?data: ::Hash[Symbol, top]?,
+          ?profile: ::Hash[Symbol, top]?,
+          ?recipient: String?,
+          ?template: String?,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          automation: Courier::Automations::InvokeInvokeAdHocParams::Automation,
+          brand: String?,
+          data: ::Hash[Symbol, top]?,
+          profile: ::Hash[Symbol, top]?,
+          recipient: String?,
+          template: String?,
+          request_options: Courier::RequestOptions
+        }
+
+        type automation =
+          {
+            steps: ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::step],
+            cancelation_token: String?
+          }
+
+        class Automation < Courier::Internal::Type::BaseModel
+          attr_accessor steps: ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::step]
+
+          attr_accessor cancelation_token: String?
+
+          def initialize: (
+            steps: ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::step],
+            ?cancelation_token: String?
+          ) -> void
+
+          def to_hash: -> {
+            steps: ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::step],
+            cancelation_token: String?
+          }
+
+          type step =
+            Courier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep
+            | Courier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep
+            | Courier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep
+            | Courier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep
+            | Courier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep
+            | Courier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep
+            | Courier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep
+
+          module Step
+            extend Courier::Internal::Type::Union
+
+            type automation_delay_step =
+              {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep::action,
+                duration: String?,
+                until_: String?
+              }
+
+            class AutomationDelayStep < Courier::Internal::Type::BaseModel
+              attr_accessor action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep::action
+
+              attr_accessor duration: String?
+
+              attr_accessor until_: String?
+
+              def initialize: (
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep::action,
+                ?duration: String?,
+                ?until_: String?
+              ) -> void
+
+              def to_hash: -> {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep::action,
+                duration: String?,
+                until_: String?
+              }
+
+              type action = :delay
+
+              module Action
+                extend Courier::Internal::Type::Enum
+
+                DELAY: :delay
+
+                def self?.values: -> ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationDelayStep::action]
+              end
+            end
+
+            type automation_send_step =
+              {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep::action,
+                brand: String?,
+                data: ::Hash[Symbol, top]?,
+                profile: ::Hash[Symbol, top]?,
+                recipient: String?,
+                template: String?
+              }
+
+            class AutomationSendStep < Courier::Internal::Type::BaseModel
+              attr_accessor action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep::action
+
+              attr_accessor brand: String?
+
+              attr_accessor data: ::Hash[Symbol, top]?
+
+              attr_accessor profile: ::Hash[Symbol, top]?
+
+              attr_accessor recipient: String?
+
+              attr_accessor template: String?
+
+              def initialize: (
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep::action,
+                ?brand: String?,
+                ?data: ::Hash[Symbol, top]?,
+                ?profile: ::Hash[Symbol, top]?,
+                ?recipient: String?,
+                ?template: String?
+              ) -> void
+
+              def to_hash: -> {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep::action,
+                brand: String?,
+                data: ::Hash[Symbol, top]?,
+                profile: ::Hash[Symbol, top]?,
+                recipient: String?,
+                template: String?
+              }
+
+              type action = :send
+
+              module Action
+                extend Courier::Internal::Type::Enum
+
+                SEND: :send
+
+                def self?.values: -> ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendStep::action]
+              end
+            end
+
+            type automation_send_list_step =
+              {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep::action,
+                list: String,
+                brand: String?,
+                data: ::Hash[Symbol, top]?
+              }
+
+            class AutomationSendListStep < Courier::Internal::Type::BaseModel
+              attr_accessor action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep::action
+
+              attr_accessor list: String
+
+              attr_accessor brand: String?
+
+              attr_accessor data: ::Hash[Symbol, top]?
+
+              def initialize: (
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep::action,
+                list: String,
+                ?brand: String?,
+                ?data: ::Hash[Symbol, top]?
+              ) -> void
+
+              def to_hash: -> {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep::action,
+                list: String,
+                brand: String?,
+                data: ::Hash[Symbol, top]?
+              }
+
+              type action = :"send-list"
+
+              module Action
+                extend Courier::Internal::Type::Enum
+
+                SEND_LIST: :"send-list"
+
+                def self?.values: -> ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationSendListStep::action]
+              end
+            end
+
+            type automation_update_profile_step =
+              {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::action,
+                profile: ::Hash[Symbol, top],
+                merge: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::merge?,
+                recipient_id: String?
+              }
+
+            class AutomationUpdateProfileStep < Courier::Internal::Type::BaseModel
+              attr_accessor action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::action
+
+              attr_accessor profile: ::Hash[Symbol, top]
+
+              attr_accessor merge: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::merge?
+
+              attr_accessor recipient_id: String?
+
+              def initialize: (
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::action,
+                profile: ::Hash[Symbol, top],
+                ?merge: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::merge?,
+                ?recipient_id: String?
+              ) -> void
+
+              def to_hash: -> {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::action,
+                profile: ::Hash[Symbol, top],
+                merge: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::merge?,
+                recipient_id: String?
+              }
+
+              type action = :"update-profile"
+
+              module Action
+                extend Courier::Internal::Type::Enum
+
+                UPDATE_PROFILE: :"update-profile"
+
+                def self?.values: -> ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::action]
+              end
+
+              type merge = :none | :overwrite | :"soft-merge" | :replace
+
+              module Merge
+                extend Courier::Internal::Type::Enum
+
+                NONE: :none
+                OVERWRITE: :overwrite
+                SOFT_MERGE: :"soft-merge"
+                REPLACE: :replace
+
+                def self?.values: -> ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationUpdateProfileStep::merge]
+              end
+            end
+
+            type automation_cancel_step =
+              {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep::action,
+                cancelation_token: String
+              }
+
+            class AutomationCancelStep < Courier::Internal::Type::BaseModel
+              attr_accessor action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep::action
+
+              attr_accessor cancelation_token: String
+
+              def initialize: (
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep::action,
+                cancelation_token: String
+              ) -> void
+
+              def to_hash: -> {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep::action,
+                cancelation_token: String
+              }
+
+              type action = :cancel
+
+              module Action
+                extend Courier::Internal::Type::Enum
+
+                CANCEL: :cancel
+
+                def self?.values: -> ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationCancelStep::action]
+              end
+            end
+
+            type automation_fetch_data_step =
+              {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::action,
+                webhook: Courier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook,
+                merge_strategy: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::merge_strategy?
+              }
+
+            class AutomationFetchDataStep < Courier::Internal::Type::BaseModel
+              attr_accessor action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::action
+
+              attr_accessor webhook: Courier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook
+
+              attr_accessor merge_strategy: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::merge_strategy?
+
+              def initialize: (
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::action,
+                webhook: Courier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook,
+                ?merge_strategy: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::merge_strategy?
+              ) -> void
+
+              def to_hash: -> {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::action,
+                webhook: Courier::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook,
+                merge_strategy: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::merge_strategy?
+              }
+
+              type action = :"fetch-data"
+
+              module Action
+                extend Courier::Internal::Type::Enum
+
+                FETCH_DATA: :"fetch-data"
+
+                def self?.values: -> ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::action]
+              end
+
+              type webhook =
+                {
+                  method_: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook::method_,
+                  url: String,
+                  body: String?,
+                  headers: ::Hash[Symbol, String]?
+                }
+
+              class Webhook < Courier::Internal::Type::BaseModel
+                attr_accessor method_: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook::method_
+
+                attr_accessor url: String
+
+                attr_accessor body: String?
+
+                attr_accessor headers: ::Hash[Symbol, String]?
+
+                def initialize: (
+                  method_: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook::method_,
+                  url: String,
+                  ?body: String?,
+                  ?headers: ::Hash[Symbol, String]?
+                ) -> void
+
+                def to_hash: -> {
+                  method_: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook::method_,
+                  url: String,
+                  body: String?,
+                  headers: ::Hash[Symbol, String]?
+                }
+
+                type method_ = :GET | :POST | :PUT | :PATCH | :DELETE
+
+                module Method
+                  extend Courier::Internal::Type::Enum
+
+                  GET: :GET
+                  POST: :POST
+                  PUT: :PUT
+                  PATCH: :PATCH
+                  DELETE: :DELETE
+
+                  def self?.values: -> ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::Webhook::method_]
+                end
+              end
+
+              type merge_strategy = :replace | :overwrite | :"soft-merge"
+
+              module MergeStrategy
+                extend Courier::Internal::Type::Enum
+
+                REPLACE: :replace
+                OVERWRITE: :overwrite
+                SOFT_MERGE: :"soft-merge"
+
+                def self?.values: -> ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationFetchDataStep::merge_strategy]
+              end
+            end
+
+            type automation_invoke_step =
+              {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep::action,
+                template: String
+              }
+
+            class AutomationInvokeStep < Courier::Internal::Type::BaseModel
+              attr_accessor action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep::action
+
+              attr_accessor template: String
+
+              def initialize: (
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep::action,
+                template: String
+              ) -> void
+
+              def to_hash: -> {
+                action: Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep::action,
+                template: String
+              }
+
+              type action = :invoke
+
+              module Action
+                extend Courier::Internal::Type::Enum
+
+                INVOKE: :invoke
+
+                def self?.values: -> ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::Step::AutomationInvokeStep::action]
+              end
+            end
+
+            def self?.variants: -> ::Array[Courier::Models::Automations::InvokeInvokeAdHocParams::Automation::step]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/automations/invoke_invoke_by_template_params.rbs

@@ -0,0 +1,48 @@
+module Courier
+  module Models
+    module Automations
+      type invoke_invoke_by_template_params =
+        {
+          recipient: String?,
+          brand: String?,
+          data: ::Hash[Symbol, top]?,
+          profile: ::Hash[Symbol, top]?,
+          template: String?
+        }
+        & Courier::Internal::Type::request_parameters
+
+      class InvokeInvokeByTemplateParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        attr_accessor recipient: String?
+
+        attr_accessor brand: String?
+
+        attr_accessor data: ::Hash[Symbol, top]?
+
+        attr_accessor profile: ::Hash[Symbol, top]?
+
+        attr_accessor template: String?
+
+        def initialize: (
+          recipient: String?,
+          ?brand: String?,
+          ?data: ::Hash[Symbol, top]?,
+          ?profile: ::Hash[Symbol, top]?,
+          ?template: String?,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          recipient: String?,
+          brand: String?,
+          data: ::Hash[Symbol, top]?,
+          profile: ::Hash[Symbol, top]?,
+          template: String?,
+          request_options: Courier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/courier/models/base_check.rbs

@@ -0,0 +1,52 @@
+module Courier
+  module Models
+    type base_check =
+      {
+        id: String,
+        status: Courier::Models::BaseCheck::status,
+        type: Courier::Models::BaseCheck::type_
+      }
+
+    class BaseCheck < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor status: Courier::Models::BaseCheck::status
+
+      attr_accessor type: Courier::Models::BaseCheck::type_
+
+      def initialize: (
+        id: String,
+        status: Courier::Models::BaseCheck::status,
+        type: Courier::Models::BaseCheck::type_
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        status: Courier::Models::BaseCheck::status,
+        type: Courier::Models::BaseCheck::type_
+      }
+
+      type status = :RESOLVED | :FAILED | :PENDING
+
+      module Status
+        extend Courier::Internal::Type::Enum
+
+        RESOLVED: :RESOLVED
+        FAILED: :FAILED
+        PENDING: :PENDING
+
+        def self?.values: -> ::Array[Courier::Models::BaseCheck::status]
+      end
+
+      type type_ = :custom
+
+      module Type
+        extend Courier::Internal::Type::Enum
+
+        CUSTOM: :custom
+
+        def self?.values: -> ::Array[Courier::Models::BaseCheck::type_]
+      end
+    end
+  end
+end

data/sig/courier/models/base_template_tenant_association.rbs

@@ -0,0 +1,40 @@
+module Courier
+  module Models
+    type base_template_tenant_association =
+      {
+        id: String,
+        created_at: String,
+        published_at: String,
+        updated_at: String,
+        version: String
+      }
+
+    class BaseTemplateTenantAssociation < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: String
+
+      attr_accessor published_at: String
+
+      attr_accessor updated_at: String
+
+      attr_accessor version: String
+
+      def initialize: (
+        id: String,
+        created_at: String,
+        published_at: String,
+        updated_at: String,
+        version: String
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created_at: String,
+        published_at: String,
+        updated_at: String,
+        version: String
+      }
+    end
+  end
+end

data/sig/courier/models/brand.rbs

@@ -0,0 +1,55 @@
+module Courier
+  module Models
+    type brand =
+      {
+        id: String,
+        created: Integer,
+        name: String,
+        updated: Integer,
+        published: Integer?,
+        settings: Courier::BrandSettings?,
+        snippets: Courier::BrandSnippets?,
+        version: String?
+      }
+
+    class Brand < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created: Integer
+
+      attr_accessor name: String
+
+      attr_accessor updated: Integer
+
+      attr_accessor published: Integer?
+
+      attr_accessor settings: Courier::BrandSettings?
+
+      attr_accessor snippets: Courier::BrandSnippets?
+
+      attr_accessor version: String?
+
+      def initialize: (
+        id: String,
+        created: Integer,
+        name: String,
+        updated: Integer,
+        ?published: Integer?,
+        ?settings: Courier::BrandSettings?,
+        ?snippets: Courier::BrandSnippets?,
+        ?version: String?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created: Integer,
+        name: String,
+        updated: Integer,
+        published: Integer?,
+        settings: Courier::BrandSettings?,
+        snippets: Courier::BrandSnippets?,
+        version: String?
+      }
+    end
+  end
+end

data/sig/courier/models/brand_colors.rbs

@@ -0,0 +1,19 @@
+module Courier
+  module Models
+    type brand_colors = { primary: String, secondary: String }
+
+    class BrandColors < Courier::Internal::Type::BaseModel
+      attr_reader primary: String?
+
+      def primary=: (String) -> String
+
+      attr_reader secondary: String?
+
+      def secondary=: (String) -> String
+
+      def initialize: (?primary: String, ?secondary: String) -> void
+
+      def to_hash: -> { primary: String, secondary: String }
+    end
+  end
+end

data/sig/courier/models/brand_create_params.rbs

@@ -0,0 +1,41 @@
+module Courier
+  module Models
+    type brand_create_params =
+      {
+        name: String,
+        id: String?,
+        settings: Courier::BrandSettings?,
+        snippets: Courier::BrandSnippets?
+      }
+      & Courier::Internal::Type::request_parameters
+
+    class BrandCreateParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor name: String
+
+      attr_accessor id: String?
+
+      attr_accessor settings: Courier::BrandSettings?
+
+      attr_accessor snippets: Courier::BrandSnippets?
+
+      def initialize: (
+        name: String,
+        ?id: String?,
+        ?settings: Courier::BrandSettings?,
+        ?snippets: Courier::BrandSnippets?,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        name: String,
+        id: String?,
+        settings: Courier::BrandSettings?,
+        snippets: Courier::BrandSnippets?,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end