knockapi 0.6.1 → 1.1.0

data/rbi/knockapi/models/identify_user_request.rbi

@@ -0,0 +1,164 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::IdentifyUserRequest, Knockapi::Internal::AnyHash)
+        end
+
+      # URL to the user's avatar image.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :avatar
+
+      # A request to set channel data for a type of channel inline.
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[
+              Symbol,
+              T.any(
+                Knockapi::Recipients::PushChannelData,
+                Knockapi::Recipients::OneSignalChannelData,
+                Knockapi::Recipients::SlackChannelData,
+                Knockapi::Recipients::MsTeamsChannelData,
+                Knockapi::Recipients::DiscordChannelData
+              )
+            ]
+          )
+        )
+      end
+      attr_accessor :channel_data
+
+      # The creation date of the user from your system.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at
+
+      # The primary email address for the user.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # The locale of the user. Used for [message localization](/concepts/translations).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :locale
+
+      # Display name of the user.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+      # user (required for SMS channels).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_number
+
+      # Inline set preferences for a recipient, where the key is the preference set id.
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
+        )
+      end
+      attr_accessor :preferences
+
+      # The timezone of the user. Must be a
+      # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+      # Used
+      # for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :timezone
+
+      # A set of parameters to identify a user with. Does not include the user ID, as
+      # that's specified elsewhere in the request. You can supply any additional
+      # properties you'd like to upsert for the user.
+      sig do
+        params(
+          avatar: T.nilable(String),
+          channel_data:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  Knockapi::Recipients::PushChannelData::OrHash,
+                  Knockapi::Recipients::OneSignalChannelData::OrHash,
+                  Knockapi::Recipients::SlackChannelData::OrHash,
+                  Knockapi::Recipients::MsTeamsChannelData::OrHash,
+                  Knockapi::Recipients::DiscordChannelData::OrHash
+                )
+              ]
+            ),
+          created_at: T.nilable(Time),
+          email: T.nilable(String),
+          locale: T.nilable(String),
+          name: T.nilable(String),
+          phone_number: T.nilable(String),
+          preferences:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Knockapi::Recipients::PreferenceSetRequest::OrHash
+              ]
+            ),
+          timezone: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # URL to the user's avatar image.
+        avatar: nil,
+        # A request to set channel data for a type of channel inline.
+        channel_data: nil,
+        # The creation date of the user from your system.
+        created_at: nil,
+        # The primary email address for the user.
+        email: nil,
+        # The locale of the user. Used for [message localization](/concepts/translations).
+        locale: nil,
+        # Display name of the user.
+        name: nil,
+        # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+        # user (required for SMS channels).
+        phone_number: nil,
+        # Inline set preferences for a recipient, where the key is the preference set id.
+        preferences: nil,
+        # The timezone of the user. Must be a
+        # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+        # Used
+        # for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+        timezone: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            avatar: T.nilable(String),
+            channel_data:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    Knockapi::Recipients::PushChannelData,
+                    Knockapi::Recipients::OneSignalChannelData,
+                    Knockapi::Recipients::SlackChannelData,
+                    Knockapi::Recipients::MsTeamsChannelData,
+                    Knockapi::Recipients::DiscordChannelData
+                  )
+                ]
+              ),
+            created_at: T.nilable(Time),
+            email: T.nilable(String),
+            locale: T.nilable(String),
+            name: T.nilable(String),
+            phone_number: T.nilable(String),
+            preferences:
+              T.nilable(
+                T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
+              ),
+            timezone: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/inline_identify_user_request.rbi

@@ -0,0 +1,176 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Knockapi::InlineIdentifyUserRequest,
+            Knockapi::Internal::AnyHash
+          )
+        end
+
+      # The ID for the user that you set when identifying them in Knock.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # URL to the user's avatar image.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :avatar
+
+      # A request to set channel data for a type of channel inline.
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[
+              Symbol,
+              T.any(
+                Knockapi::Recipients::PushChannelData,
+                Knockapi::Recipients::OneSignalChannelData,
+                Knockapi::Recipients::SlackChannelData,
+                Knockapi::Recipients::MsTeamsChannelData,
+                Knockapi::Recipients::DiscordChannelData
+              )
+            ]
+          )
+        )
+      end
+      attr_accessor :channel_data
+
+      # The creation date of the user from your system.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at
+
+      # The primary email address for the user.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :email
+
+      # The locale of the user. Used for [message localization](/concepts/translations).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :locale
+
+      # Display name of the user.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+      # user (required for SMS channels).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :phone_number
+
+      # Inline set preferences for a recipient, where the key is the preference set id.
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
+        )
+      end
+      attr_accessor :preferences
+
+      # The timezone of the user. Must be a
+      # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+      # Used
+      # for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :timezone
+
+      # A set of parameters to inline-identify a user with. Inline identifying the user
+      # will ensure that the user is available before the request is executed in Knock.
+      # It will perform an upsert for the user you're supplying, replacing any
+      # properties specified.
+      sig do
+        params(
+          id: String,
+          avatar: T.nilable(String),
+          channel_data:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  Knockapi::Recipients::PushChannelData::OrHash,
+                  Knockapi::Recipients::OneSignalChannelData::OrHash,
+                  Knockapi::Recipients::SlackChannelData::OrHash,
+                  Knockapi::Recipients::MsTeamsChannelData::OrHash,
+                  Knockapi::Recipients::DiscordChannelData::OrHash
+                )
+              ]
+            ),
+          created_at: T.nilable(Time),
+          email: T.nilable(String),
+          locale: T.nilable(String),
+          name: T.nilable(String),
+          phone_number: T.nilable(String),
+          preferences:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Knockapi::Recipients::PreferenceSetRequest::OrHash
+              ]
+            ),
+          timezone: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID for the user that you set when identifying them in Knock.
+        id:,
+        # URL to the user's avatar image.
+        avatar: nil,
+        # A request to set channel data for a type of channel inline.
+        channel_data: nil,
+        # The creation date of the user from your system.
+        created_at: nil,
+        # The primary email address for the user.
+        email: nil,
+        # The locale of the user. Used for [message localization](/concepts/translations).
+        locale: nil,
+        # Display name of the user.
+        name: nil,
+        # The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+        # user (required for SMS channels).
+        phone_number: nil,
+        # Inline set preferences for a recipient, where the key is the preference set id.
+        preferences: nil,
+        # The timezone of the user. Must be a
+        # valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+        # Used
+        # for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
+        timezone: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            avatar: T.nilable(String),
+            channel_data:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    Knockapi::Recipients::PushChannelData,
+                    Knockapi::Recipients::OneSignalChannelData,
+                    Knockapi::Recipients::SlackChannelData,
+                    Knockapi::Recipients::MsTeamsChannelData,
+                    Knockapi::Recipients::DiscordChannelData
+                  )
+                ]
+              ),
+            created_at: T.nilable(Time),
+            email: T.nilable(String),
+            locale: T.nilable(String),
+            name: T.nilable(String),
+            phone_number: T.nilable(String),
+            preferences:
+              T.nilable(
+                T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
+              ),
+            timezone: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/inline_object_request.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    class InlineObjectRequest < Knockapi::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Knockapi::InlineObjectRequest, Knockapi::Internal::AnyHash)
+        end
+
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The collection this object belongs to.
+      sig { returns(String) }
+      attr_accessor :collection
+
+      # A request to set channel data for a type of channel inline.
+      sig do
+        returns(
+          T.nilable(
+            T::Hash[
+              Symbol,
+              T.any(
+                Knockapi::Recipients::PushChannelData,
+                Knockapi::Recipients::OneSignalChannelData,
+                Knockapi::Recipients::SlackChannelData,
+                Knockapi::Recipients::MsTeamsChannelData,
+                Knockapi::Recipients::DiscordChannelData
+              )
+            ]
+          )
+        )
+      end
+      attr_accessor :channel_data
+
+      # Timestamp when the resource was created.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :created_at
+
+      # Inline set preferences for a recipient, where the key is the preference set id.
+      sig do
+        returns(
+          T.nilable(T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest])
+        )
+      end
+      attr_accessor :preferences
+
+      # A custom [Object](/concepts/objects) entity which belongs to a collection.
+      sig do
+        params(
+          id: String,
+          collection: String,
+          channel_data:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                T.any(
+                  Knockapi::Recipients::PushChannelData::OrHash,
+                  Knockapi::Recipients::OneSignalChannelData::OrHash,
+                  Knockapi::Recipients::SlackChannelData::OrHash,
+                  Knockapi::Recipients::MsTeamsChannelData::OrHash,
+                  Knockapi::Recipients::DiscordChannelData::OrHash
+                )
+              ]
+            ),
+          created_at: T.nilable(Time),
+          preferences:
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Knockapi::Recipients::PreferenceSetRequest::OrHash
+              ]
+            )
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the object.
+        id:,
+        # The collection this object belongs to.
+        collection:,
+        # A request to set channel data for a type of channel inline.
+        channel_data: nil,
+        # Timestamp when the resource was created.
+        created_at: nil,
+        # Inline set preferences for a recipient, where the key is the preference set id.
+        preferences: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            collection: String,
+            channel_data:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  T.any(
+                    Knockapi::Recipients::PushChannelData,
+                    Knockapi::Recipients::OneSignalChannelData,
+                    Knockapi::Recipients::SlackChannelData,
+                    Knockapi::Recipients::MsTeamsChannelData,
+                    Knockapi::Recipients::DiscordChannelData
+                  )
+                ]
+              ),
+            created_at: T.nilable(Time),
+            preferences:
+              T.nilable(
+                T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
+              )
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/knockapi/models/inline_tenant_request.rbi

@@ -0,0 +1,18 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    # An request to set a tenant inline.
+    module InlineTenantRequest
+      extend Knockapi::Internal::Type::Union
+
+      Variants = T.type_alias { T.any(String, Knockapi::TenantRequest) }
+
+      sig do
+        override.returns(T::Array[Knockapi::InlineTenantRequest::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Integrations
+      class CensusCustomDestinationParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Integrations::CensusCustomDestinationParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the RPC request.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The JSON-RPC version.
+        sig { returns(String) }
+        attr_accessor :jsonrpc
+
+        # The method name to execute.
+        sig { returns(String) }
+        attr_accessor :method_
+
+        # The parameters for the method.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :params
+
+        sig { params(params: T::Hash[Symbol, T.anything]).void }
+        attr_writer :params
+
+        sig do
+          params(
+            id: String,
+            jsonrpc: String,
+            method_: String,
+            params: T::Hash[Symbol, T.anything],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the RPC request.
+          id:,
+          # The JSON-RPC version.
+          jsonrpc:,
+          # The method name to execute.
+          method_:,
+          # The parameters for the method.
+          params: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              jsonrpc: String,
+              method_: String,
+              params: T::Hash[Symbol, T.anything],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Integrations
+      class CensusCustomDestinationResponse < Knockapi::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Models::Integrations::CensusCustomDestinationResponse,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The request ID.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # The result of the RPC call.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :result
+
+        sig { params(result: T::Hash[Symbol, T.anything]).void }
+        attr_writer :result
+
+        sig do
+          params(id: String, result: T::Hash[Symbol, T.anything]).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The request ID.
+          id: nil,
+          # The result of the RPC call.
+          result: nil
+        )
+        end
+
+        sig do
+          override.returns({ id: String, result: T::Hash[Symbol, T.anything] })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Knockapi
+  module Models
+    module Integrations
+      class HightouchEmbeddedDestinationParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Knockapi::Integrations::HightouchEmbeddedDestinationParams,
+              Knockapi::Internal::AnyHash
+            )
+          end
+
+        # The unique identifier for the RPC request.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The JSON-RPC version.
+        sig { returns(String) }
+        attr_accessor :jsonrpc
+
+        # The method name to execute.
+        sig { returns(String) }
+        attr_accessor :method_
+
+        # The parameters for the method.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :params
+
+        sig { params(params: T::Hash[Symbol, T.anything]).void }
+        attr_writer :params
+
+        sig do
+          params(
+            id: String,
+            jsonrpc: String,
+            method_: String,
+            params: T::Hash[Symbol, T.anything],
+            request_options: Knockapi::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique identifier for the RPC request.
+          id:,
+          # The JSON-RPC version.
+          jsonrpc:,
+          # The method name to execute.
+          method_:,
+          # The parameters for the method.
+          params: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              jsonrpc: String,
+              method_: String,
+              params: T::Hash[Symbol, T.anything],
+              request_options: Knockapi::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end