knockapi 0.6.1 → 1.1.0

data/lib/knockapi/models/tenant_set_params.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Tenants#set
+    class TenantSetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute channel_data
+      #   A request to set channel data for a type of channel inline.
+      #
+      #   @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
+      optional :channel_data,
+               -> {
+                 Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
+               },
+               nil?: true
+
+      # @!attribute preferences
+      #   Inline set preferences for a recipient, where the key is the preference set id.
+      #
+      #   @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
+      optional :preferences,
+               -> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
+               nil?: true
+
+      # @!attribute settings
+      #   The settings for the tenant. Includes branding and preference set.
+      #
+      #   @return [Knockapi::TenantSetParams::Settings, nil]
+      optional :settings, -> { Knockapi::TenantSetParams::Settings }
+
+      # @!method initialize(channel_data: nil, preferences: nil, settings: nil, request_options: {})
+      #   @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
+      #
+      #   @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
+      #
+      #   @param settings [Knockapi::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      class Settings < Knockapi::Internal::Type::BaseModel
+        # @!attribute branding
+        #   The branding for the tenant.
+        #
+        #   @return [Knockapi::TenantSetParams::Settings::Branding, nil]
+        optional :branding, -> { Knockapi::TenantSetParams::Settings::Branding }
+
+        # @!attribute preference_set
+        #   A request to set a preference set for a recipient.
+        #
+        #   @return [Knockapi::Recipients::PreferenceSetRequest, nil]
+        optional :preference_set, -> { Knockapi::Recipients::PreferenceSetRequest }, nil?: true
+
+        # @!method initialize(branding: nil, preference_set: nil)
+        #   The settings for the tenant. Includes branding and preference set.
+        #
+        #   @param branding [Knockapi::TenantSetParams::Settings::Branding] The branding for the tenant.
+        #
+        #   @param preference_set [Knockapi::Recipients::PreferenceSetRequest, nil] A request to set a preference set for a recipient.
+
+        # @see Knockapi::TenantSetParams::Settings#branding
+        class Branding < Knockapi::Internal::Type::BaseModel
+          # @!attribute icon_url
+          #   The icon URL for the tenant. Must point to a valid image with an image MIME
+          #   type.
+          #
+          #   @return [String, nil]
+          optional :icon_url, String, nil?: true
+
+          # @!attribute logo_url
+          #   The logo URL for the tenant. Must point to a valid image with an image MIME
+          #   type.
+          #
+          #   @return [String, nil]
+          optional :logo_url, String, nil?: true
+
+          # @!attribute primary_color
+          #   The primary color for the tenant, provided as a hex value.
+          #
+          #   @return [String, nil]
+          optional :primary_color, String, nil?: true
+
+          # @!attribute primary_color_contrast
+          #   The primary color contrast for the tenant, provided as a hex value.
+          #
+          #   @return [String, nil]
+          optional :primary_color_contrast, String, nil?: true
+
+          # @!method initialize(icon_url: nil, logo_url: nil, primary_color: nil, primary_color_contrast: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::TenantSetParams::Settings::Branding} for more details.
+          #
+          #   The branding for the tenant.
+          #
+          #   @param icon_url [String, nil] The icon URL for the tenant. Must point to a valid image with an image MIME type
+          #
+          #   @param logo_url [String, nil] The logo URL for the tenant. Must point to a valid image with an image MIME type
+          #
+          #   @param primary_color [String, nil] The primary color for the tenant, provided as a hex value.
+          #
+          #   @param primary_color_contrast [String, nil] The primary color contrast for the tenant, provided as a hex value.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/tenants/bulk_delete_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Tenants
+      # @see Knockapi::Resources::Tenants::Bulk#delete
+      class BulkDeleteParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute tenant_ids
+        #   The IDs of the tenants to delete.
+        #
+        #   @return [Array<String>]
+        required :tenant_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(tenant_ids:, request_options: {})
+        #   @param tenant_ids [Array<String>] The IDs of the tenants to delete.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/tenants/bulk_set_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Tenants
+      # @see Knockapi::Resources::Tenants::Bulk#set
+      class BulkSetParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute tenants
+        #   The tenants to be upserted.
+        #
+        #   @return [Array<String, Knockapi::TenantRequest>]
+        required :tenants, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::InlineTenantRequest] }
+
+        # @!method initialize(tenants:, request_options: {})
+        #   @param tenants [Array<String, Knockapi::TenantRequest>] The tenants to be upserted.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/knockapi/models/user.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#update
+    class User < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID for the user that you set when identifying them in Knock.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute updated_at
+      #   The timestamp when the resource was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute avatar
+      #   URL to the user's avatar image.
+      #
+      #   @return [String, nil]
+      optional :avatar, String, nil?: true
+
+      # @!attribute created_at
+      #   The creation date of the user from your system.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, nil?: true
+
+      # @!attribute email
+      #   The primary email address for the user.
+      #
+      #   @return [String, nil]
+      optional :email, String, nil?: true
+
+      # @!attribute name
+      #   Display name of the user.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute phone_number
+      #   The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+      #   user (required for SMS channels).
+      #
+      #   @return [String, nil]
+      optional :phone_number, String, nil?: true
+
+      # @!attribute timezone
+      #   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).
+      #
+      #   @return [String, nil]
+      optional :timezone, String, nil?: true
+
+      # @!method initialize(id:, _typename:, updated_at:, avatar: nil, created_at: nil, email: nil, name: nil, phone_number: nil, timezone: nil)
+      #   Some parameter documentations has been truncated, see {Knockapi::User} for more
+      #   details.
+      #
+      #   A [User](/concepts/users) represents an individual in your system who can
+      #   receive notifications through Knock. Users are the most common recipients of
+      #   notifications and are always referenced by your internal identifier.
+      #
+      #   @param id [String] The ID for the user that you set when identifying them in Knock.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param updated_at [Time] The timestamp when the resource was last updated.
+      #
+      #   @param avatar [String, nil] URL to the user's avatar image.
+      #
+      #   @param created_at [Time, nil] The creation date of the user from your system.
+      #
+      #   @param email [String, nil] The primary email address for the user.
+      #
+      #   @param name [String, nil] Display name of the user.
+      #
+      #   @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
+      #
+      #   @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
+    end
+  end
+end

data/lib/knockapi/models/user_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#delete
+    class UserDeleteParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/user_delete_response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    UserDeleteResponse = String
+  end
+end

data/lib/knockapi/models/user_get_channel_data_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#get_channel_data
+    class UserGetChannelDataParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/user_get_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#get
+    class UserGetParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/user_get_preferences_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#get_preferences
+    class UserGetPreferencesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!attribute tenant
+      #   The unique identifier for the tenant.
+      #
+      #   @return [String, nil]
+      optional :tenant, String
+
+      # @!method initialize(tenant: nil, request_options: {})
+      #   @param tenant [String] The unique identifier for the tenant.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/user_list_messages_params.rb

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#list_messages
+    class UserListMessagesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!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 channel_id
+      #   Limits the results to items with the corresponding channel ID.
+      #
+      #   @return [String, nil]
+      optional :channel_id, String
+
+      # @!attribute engagement_status
+      #   Limits the results to messages with the given engagement status.
+      #
+      #   @return [Array<Symbol, Knockapi::UserListMessagesParams::EngagementStatus>, nil]
+      optional :engagement_status,
+               -> {
+                 Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListMessagesParams::EngagementStatus]
+               }
+
+      # @!attribute inserted_at
+      #
+      #   @return [Knockapi::UserListMessagesParams::InsertedAt, nil]
+      optional :inserted_at, -> { Knockapi::UserListMessagesParams::InsertedAt }
+
+      # @!attribute message_ids
+      #   Limits the results to only the message IDs given (max 50). Note: when using this
+      #   option, the results will be subject to any other filters applied to the query.
+      #
+      #   @return [Array<String>, nil]
+      optional :message_ids, Knockapi::Internal::Type::ArrayOf[String]
+
+      # @!attribute page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute source
+      #   Limits the results to messages triggered by the given workflow key.
+      #
+      #   @return [String, nil]
+      optional :source, String
+
+      # @!attribute status
+      #   Limits the results to messages with the given delivery status.
+      #
+      #   @return [Array<Symbol, Knockapi::UserListMessagesParams::Status>, nil]
+      optional :status,
+               -> {
+                 Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListMessagesParams::Status]
+               }
+
+      # @!attribute tenant
+      #   Limits the results to items with the corresponding tenant.
+      #
+      #   @return [String, nil]
+      optional :tenant, String
+
+      # @!attribute trigger_data
+      #   Limits the results to only messages that were generated with the given data. See
+      #   [trigger data filtering](/api-reference/overview/trigger-data-filtering) for
+      #   more information.
+      #
+      #   @return [String, nil]
+      optional :trigger_data, String
+
+      # @!attribute workflow_categories
+      #   Limits the results to messages related to any of the provided categories.
+      #
+      #   @return [Array<String>, nil]
+      optional :workflow_categories, Knockapi::Internal::Type::ArrayOf[String]
+
+      # @!attribute workflow_recipient_run_id
+      #   Limits the results to messages for a specific recipient's workflow run.
+      #
+      #   @return [String, nil]
+      optional :workflow_recipient_run_id, String
+
+      # @!attribute workflow_run_id
+      #   Limits the results to messages associated with the top-level workflow run ID
+      #   returned by the workflow trigger request.
+      #
+      #   @return [String, nil]
+      optional :workflow_run_id, String
+
+      # @!method initialize(after: nil, before: nil, channel_id: nil, engagement_status: nil, inserted_at: nil, message_ids: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, workflow_recipient_run_id: nil, workflow_run_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::UserListMessagesParams} for more details.
+      #
+      #   @param after [String] The cursor to fetch entries after.
+      #
+      #   @param before [String] The cursor to fetch entries before.
+      #
+      #   @param channel_id [String] Limits the results to items with the corresponding channel ID.
+      #
+      #   @param engagement_status [Array<Symbol, Knockapi::UserListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
+      #
+      #   @param inserted_at [Knockapi::UserListMessagesParams::InsertedAt]
+      #
+      #   @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
+      #
+      #   @param page_size [Integer] The number of items per page.
+      #
+      #   @param source [String] Limits the results to messages triggered by the given workflow key.
+      #
+      #   @param status [Array<Symbol, Knockapi::UserListMessagesParams::Status>] Limits the results to messages with the given delivery status.
+      #
+      #   @param tenant [String] Limits the results to items with the corresponding tenant.
+      #
+      #   @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
+      #
+      #   @param workflow_categories [Array<String>] Limits the results to messages related to any of the provided categories.
+      #
+      #   @param workflow_recipient_run_id [String] Limits the results to messages for a specific recipient's workflow run.
+      #
+      #   @param workflow_run_id [String] Limits the results to messages associated with the top-level workflow run ID ret
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      module EngagementStatus
+        extend Knockapi::Internal::Type::Enum
+
+        SEEN = :seen
+        READ = :read
+        INTERACTED = :interacted
+        LINK_CLICKED = :link_clicked
+        ARCHIVED = :archived
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class InsertedAt < Knockapi::Internal::Type::BaseModel
+        # @!attribute gt
+        #   Limits the results to messages inserted after the given date.
+        #
+        #   @return [String, nil]
+        optional :gt, String
+
+        # @!attribute gte
+        #   Limits the results to messages inserted after or on the given date.
+        #
+        #   @return [String, nil]
+        optional :gte, String
+
+        # @!attribute lt
+        #   Limits the results to messages inserted before the given date.
+        #
+        #   @return [String, nil]
+        optional :lt, String
+
+        # @!attribute lte
+        #   Limits the results to messages inserted before or on the given date.
+        #
+        #   @return [String, nil]
+        optional :lte, String
+
+        # @!method initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+        #   @param gt [String] Limits the results to messages inserted after the given date.
+        #
+        #   @param gte [String] Limits the results to messages inserted after or on the given date.
+        #
+        #   @param lt [String] Limits the results to messages inserted before the given date.
+        #
+        #   @param lte [String] Limits the results to messages inserted before or on the given date.
+      end
+
+      module Status
+        extend Knockapi::Internal::Type::Enum
+
+        QUEUED = :queued
+        SENT = :sent
+        DELIVERED = :delivered
+        DELIVERY_ATTEMPTED = :delivery_attempted
+        UNDELIVERED = :undelivered
+        NOT_SENT = :not_sent
+        BOUNCED = :bounced
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/knockapi/models/user_list_params.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#list
+    class UserListParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!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 include
+      #   Associated resources to include in the response.
+      #
+      #   @return [Array<Symbol, Knockapi::UserListParams::Include>, nil]
+      optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListParams::Include] }
+
+      # @!attribute page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(after: nil, before: nil, include: nil, page_size: nil, request_options: {})
+      #   @param after [String] The cursor to fetch entries after.
+      #
+      #   @param before [String] The cursor to fetch entries before.
+      #
+      #   @param include [Array<Symbol, Knockapi::UserListParams::Include>] Associated resources to include in the response.
+      #
+      #   @param page_size [Integer] The number of items per page.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+      module Include
+        extend Knockapi::Internal::Type::Enum
+
+        PREFERENCES = :preferences
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/knockapi/models/user_list_preferences_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#list_preferences
+    class UserListPreferencesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/user_list_preferences_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @type [Knockapi::Internal::Type::Converter]
+    UserListPreferencesResponse =
+      Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Recipients::PreferenceSet }]
+  end
+end

data/lib/knockapi/models/user_list_schedules_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Users#list_schedules
+    class UserListSchedulesParams < Knockapi::Internal::Type::BaseModel
+      extend Knockapi::Internal::Type::RequestParameters::Converter
+      include Knockapi::Internal::Type::RequestParameters
+
+      # @!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 tenant
+      #   The tenant ID to filter schedules for.
+      #
+      #   @return [String, nil]
+      optional :tenant, String
+
+      # @!attribute workflow
+      #   The workflow key to filter schedules for.
+      #
+      #   @return [String, nil]
+      optional :workflow, String
+
+      # @!method initialize(after: nil, before: nil, page_size: nil, tenant: nil, workflow: nil, request_options: {})
+      #   @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 tenant [String] The tenant ID to filter schedules for.
+      #
+      #   @param workflow [String] The workflow key to filter schedules for.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end