knockapi 0.6.1 → 1.1.0

data/lib/knockapi/models/recipients/preference_set_request.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class PreferenceSetRequest < Knockapi::Internal::Type::BaseModel
+        # @!attribute categories
+        #   An object where the key is the category and the values are the preference
+        #   settings for that category.
+        #
+        #   @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
+        optional :categories,
+                 -> {
+                   Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSetRequest::Category]
+                 },
+                 nil?: true
+
+        # @!attribute channel_types
+        #   Channel type preferences.
+        #
+        #   @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
+        optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
+
+        # @!attribute workflows
+        #   An object where the key is the workflow key and the values are the preference
+        #   settings for that workflow.
+        #
+        #   @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
+        optional :workflows,
+                 -> {
+                   Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSetRequest::Workflow]
+                 },
+                 nil?: true
+
+        # @!method initialize(categories: nil, channel_types: nil, workflows: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Recipients::PreferenceSetRequest} for more details.
+        #
+        #   A request to set a preference set for a recipient.
+        #
+        #   @param categories [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
+        #
+        #   @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
+        #
+        #   @param workflows [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
+
+        # Workflow or category preferences within a preference set
+        module Category
+          extend Knockapi::Internal::Type::Union
+
+          variant Knockapi::Internal::Type::Boolean
+
+          # The settings object for a workflow or category, where you can specify channel types or conditions.
+          variant -> {
+            Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
+          }
+
+          class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            # @!attribute channel_types
+            #   Channel type preferences.
+            #
+            #   @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
+            optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
+
+            # @!attribute conditions
+            #   A list of conditions to apply to a channel type.
+            #
+            #   @return [Array<Knockapi::Condition>, nil]
+            optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
+
+            # @!method initialize(channel_types: nil, conditions: nil)
+            #   The settings object for a workflow or category, where you can specify channel
+            #   types or conditions.
+            #
+            #   @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
+            #
+            #   @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
+          end
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
+              )
+            end
+          end
+        end
+
+        # Workflow or category preferences within a preference set
+        module Workflow
+          extend Knockapi::Internal::Type::Union
+
+          variant Knockapi::Internal::Type::Boolean
+
+          # The settings object for a workflow or category, where you can specify channel types or conditions.
+          variant -> {
+            Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
+          }
+
+          class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
+            # @!attribute channel_types
+            #   Channel type preferences.
+            #
+            #   @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
+            optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
+
+            # @!attribute conditions
+            #   A list of conditions to apply to a channel type.
+            #
+            #   @return [Array<Knockapi::Condition>, nil]
+            optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
+
+            # @!method initialize(channel_types: nil, conditions: nil)
+            #   The settings object for a workflow or category, where you can specify channel
+            #   types or conditions.
+            #
+            #   @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
+            #
+            #   @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
+          end
+
+          # @!method self.variants
+          #   @return [Array(Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias do
+              T.any(
+                T::Boolean,
+                Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/recipients/push_channel_data.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class PushChannelData < Knockapi::Internal::Type::BaseModel
+        # @!attribute tokens
+        #   A list of push channel tokens.
+        #
+        #   @return [Array<String>]
+        required :tokens, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(tokens:)
+        #   The content of a push notification.
+        #
+        #   @param tokens [Array<String>] A list of push channel tokens.
+      end
+    end
+  end
+end

data/lib/knockapi/models/recipients/slack_channel_data.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class SlackChannelData < Knockapi::Internal::Type::BaseModel
+        # @!attribute connections
+        #   List of Slack channel connections.
+        #
+        #   @return [Array<Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>]
+        required :connections,
+                 -> {
+                   Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipients::SlackChannelData::Connection]
+                 }
+
+        # @!attribute token
+        #   A Slack connection token.
+        #
+        #   @return [Knockapi::Recipients::SlackChannelData::Token, nil]
+        optional :token, -> { Knockapi::Recipients::SlackChannelData::Token }, nil?: true
+
+        # @!method initialize(connections:, token: nil)
+        #   Slack channel data
+        #
+        #   @param connections [Array<Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>] List of Slack channel connections.
+        #
+        #   @param token [Knockapi::Recipients::SlackChannelData::Token, nil] A Slack connection token.
+
+        # A Slack connection, either an access token or an incoming webhook
+        module Connection
+          extend Knockapi::Internal::Type::Union
+
+          # A Slack connection token.
+          variant -> { Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection }
+
+          # A Slack connection incoming webhook.
+          variant -> { Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection }
+
+          class SlackTokenConnection < Knockapi::Internal::Type::BaseModel
+            # @!attribute access_token
+            #   A Slack access token.
+            #
+            #   @return [String, nil]
+            optional :access_token, String, nil?: true
+
+            # @!attribute channel_id
+            #   A Slack channel ID from the Slack provider.
+            #
+            #   @return [String, nil]
+            optional :channel_id, String, nil?: true
+
+            # @!attribute user_id
+            #   A Slack user ID from the Slack provider.
+            #
+            #   @return [String, nil]
+            optional :user_id, String, nil?: true
+
+            # @!method initialize(access_token: nil, channel_id: nil, user_id: nil)
+            #   A Slack connection token.
+            #
+            #   @param access_token [String, nil] A Slack access token.
+            #
+            #   @param channel_id [String, nil] A Slack channel ID from the Slack provider.
+            #
+            #   @param user_id [String, nil] A Slack user ID from the Slack provider.
+          end
+
+          class SlackIncomingWebhookConnection < Knockapi::Internal::Type::BaseModel
+            # @!attribute url
+            #   The URL of the incoming webhook for a Slack connection.
+            #
+            #   @return [String]
+            required :url, String
+
+            # @!method initialize(url:)
+            #   A Slack connection incoming webhook.
+            #
+            #   @param url [String] The URL of the incoming webhook for a Slack connection.
+          end
+
+          # @!method self.variants
+          #   @return [Array(Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias do
+              T.any(
+                Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection,
+                Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection
+              )
+            end
+          end
+        end
+
+        # @see Knockapi::Recipients::SlackChannelData#token
+        class Token < Knockapi::Internal::Type::BaseModel
+          # @!attribute access_token
+          #   A Slack access token.
+          #
+          #   @return [String, nil]
+          required :access_token, String, nil?: true
+
+          # @!method initialize(access_token:)
+          #   A Slack connection token.
+          #
+          #   @param access_token [String, nil] A Slack access token.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/recipients/subscription.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Recipients
+      class Subscription < Knockapi::Internal::Type::BaseModel
+        # @!attribute _typename
+        #   The typename of the schema.
+        #
+        #   @return [String]
+        required :_typename, String, api_name: :__typename
+
+        # @!attribute inserted_at
+        #   Timestamp when the resource was created.
+        #
+        #   @return [Time]
+        required :inserted_at, Time
+
+        # @!attribute object
+        #   A custom [Object](/concepts/objects) entity which belongs to a collection.
+        #
+        #   @return [Knockapi::Object]
+        required :object, -> { Knockapi::Object }
+
+        # @!attribute recipient
+        #   A recipient of a notification, which is either a user or an object.
+        #
+        #   @return [Knockapi::User, Knockapi::Object]
+        required :recipient, union: -> { Knockapi::Recipient }
+
+        # @!attribute updated_at
+        #   The timestamp when the resource was last updated.
+        #
+        #   @return [Time]
+        required :updated_at, Time
+
+        # @!attribute properties
+        #   The custom properties associated with the subscription relationship.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :properties, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+        # @!method initialize(_typename:, inserted_at:, object:, recipient:, updated_at:, properties: nil)
+        #   A subscription object.
+        #
+        #   @param _typename [String] The typename of the schema.
+        #
+        #   @param inserted_at [Time] Timestamp when the resource was created.
+        #
+        #   @param object [Knockapi::Object] A custom [Object](/concepts/objects) entity which belongs to a collection.
+        #
+        #   @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
+        #
+        #   @param updated_at [Time] The timestamp when the resource was last updated.
+        #
+        #   @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
+      end
+    end
+  end
+end

data/lib/knockapi/models/schedule.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Schedules#list
+    class Schedule < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the schedule.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute inserted_at
+      #   Timestamp when the resource was created.
+      #
+      #   @return [Time]
+      required :inserted_at, Time
+
+      # @!attribute recipient
+      #   A recipient of a notification, which is either a user or an object.
+      #
+      #   @return [Knockapi::User, Knockapi::Object]
+      required :recipient, union: -> { Knockapi::Recipient }
+
+      # @!attribute repeats
+      #   The repeat rule for the schedule.
+      #
+      #   @return [Array<Knockapi::ScheduleRepeatRule>]
+      required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
+
+      # @!attribute updated_at
+      #   The timestamp when the resource was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute workflow
+      #   The workflow the schedule is applied to.
+      #
+      #   @return [String]
+      required :workflow, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String, nil]
+      optional :_typename, String, api_name: :__typename
+
+      # @!attribute actor
+      #   A recipient of a notification, which is either a user or an object.
+      #
+      #   @return [Knockapi::User, Knockapi::Object, nil]
+      optional :actor, union: -> { Knockapi::Recipient }, nil?: true
+
+      # @!attribute data
+      #   An optional map of data to pass into the workflow execution.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+      # @!attribute last_occurrence_at
+      #   The last occurrence of the schedule.
+      #
+      #   @return [Time, nil]
+      optional :last_occurrence_at, Time, nil?: true
+
+      # @!attribute next_occurrence_at
+      #   The next occurrence of the schedule.
+      #
+      #   @return [Time, nil]
+      optional :next_occurrence_at, Time, nil?: true
+
+      # @!attribute tenant
+      #   The tenant to trigger the workflow for. Triggering with a tenant will use any
+      #   tenant-level overrides associated with the tenant object, and all messages
+      #   produced from workflow runs will be tagged with the tenant.
+      #
+      #   @return [String, nil]
+      optional :tenant, String, nil?: true
+
+      # @!method initialize(id:, inserted_at:, recipient:, repeats:, updated_at:, workflow:, _typename: nil, actor: nil, data: nil, last_occurrence_at: nil, next_occurrence_at: nil, tenant: nil)
+      #   Some parameter documentations has been truncated, see {Knockapi::Schedule} for
+      #   more details.
+      #
+      #   A schedule represents a recurring workflow execution.
+      #
+      #   @param id [String] Unique identifier for the schedule.
+      #
+      #   @param inserted_at [Time] Timestamp when the resource was created.
+      #
+      #   @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
+      #
+      #   @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
+      #
+      #   @param updated_at [Time] The timestamp when the resource was last updated.
+      #
+      #   @param workflow [String] The workflow the schedule is applied to.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param actor [Knockapi::User, Knockapi::Object, nil] A recipient of a notification, which is either a user or an object.
+      #
+      #   @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
+      #
+      #   @param last_occurrence_at [Time, nil] The last occurrence of the schedule.
+      #
+      #   @param next_occurrence_at [Time, nil] The next occurrence of the schedule.
+      #
+      #   @param tenant [String, nil] The tenant to trigger the workflow for. Triggering with a tenant will use any te
+    end
+  end
+end

data/lib/knockapi/models/schedule_create_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Schedules#create
+    class ScheduleCreateParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute recipients
+      #   The recipients to set the schedule for. Limited to 100 recipients per request.
+      #
+      #   @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
+      required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
+
+      # @!attribute repeats
+      #   The repeat rule for the schedule.
+      #
+      #   @return [Array<Knockapi::ScheduleRepeatRule>]
+      required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
+
+      # @!attribute workflow
+      #   The key of the workflow.
+      #
+      #   @return [String]
+      required :workflow, String
+
+      # @!attribute data
+      #   An optional map of data to pass into the workflow execution.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
+
+      # @!attribute ending_at
+      #   The ending date and time for the schedule.
+      #
+      #   @return [Time, nil]
+      optional :ending_at, Time, nil?: true
+
+      # @!attribute scheduled_at
+      #   The starting date and time for the schedule.
+      #
+      #   @return [Time, nil]
+      optional :scheduled_at, Time, nil?: true
+
+      # @!attribute tenant
+      #   An request to set a tenant inline.
+      #
+      #   @return [String, Knockapi::TenantRequest, nil]
+      optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
+
+      # @!method initialize(recipients:, repeats:, workflow:, data: nil, ending_at: nil, scheduled_at: nil, tenant: nil, request_options: {})
+      #   @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to set the schedule for. Limited to 100 recipients per request.
+      #
+      #   @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
+      #
+      #   @param workflow [String] The key of the workflow.
+      #
+      #   @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
+      #
+      #   @param ending_at [Time, nil] The ending date and time for the schedule.
+      #
+      #   @param scheduled_at [Time, nil] The starting date and time for the schedule.
+      #
+      #   @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/schedule_create_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @type [Knockapi::Internal::Type::Converter]
+    ScheduleCreateResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Schedule }]
+  end
+end

data/lib/knockapi/models/schedule_delete_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Schedules#delete
+    class ScheduleDeleteParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute schedule_ids
+      #   A list of schedule IDs.
+      #
+      #   @return [Array<String>]
+      required :schedule_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(schedule_ids:, request_options: {})
+      #   @param schedule_ids [Array<String>] A list of schedule IDs.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/schedule_delete_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @type [Knockapi::Internal::Type::Converter]
+    ScheduleDeleteResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Schedule }]
+  end
+end

data/lib/knockapi/models/schedule_list_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Schedules#list
+    class ScheduleListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute workflow
+      #   Filter by workflow key.
+      #
+      #   @return [String]
+      required :workflow, String
+
+      # @!attribute after
+      #   The cursor to fetch entries after.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   The cursor to fetch entries before.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute recipients
+      #   Filter by recipient IDs.
+      #
+      #   @return [Array<String>, nil]
+      optional :recipients, Knockapi::Internal::Type::ArrayOf[String]
+
+      # @!attribute tenant
+      #   Filter by tenant ID.
+      #
+      #   @return [String, nil]
+      optional :tenant, String
+
+      # @!method initialize(workflow:, after: nil, before: nil, page_size: nil, recipients: nil, tenant: nil, request_options: {})
+      #   @param workflow [String] Filter by workflow key.
+      #
+      #   @param after [String] The cursor to fetch entries after.
+      #
+      #   @param before [String] The cursor to fetch entries before.
+      #
+      #   @param page_size [Integer] The number of items per page.
+      #
+      #   @param recipients [Array<String>] Filter by recipient IDs.
+      #
+      #   @param tenant [String] Filter by tenant ID.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end