knockapi 0.6.1 → 1.1.0

data/lib/knockapi/models/schedule_repeat_rule.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class ScheduleRepeatRule < Knockapi::Internal::Type::BaseModel
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute frequency
+      #   The frequency of the schedule.
+      #
+      #   @return [Symbol, Knockapi::ScheduleRepeatRule::Frequency]
+      required :frequency, enum: -> { Knockapi::ScheduleRepeatRule::Frequency }
+
+      # @!attribute day_of_month
+      #   The day of the month to repeat the schedule.
+      #
+      #   @return [Integer, nil]
+      optional :day_of_month, Integer, nil?: true
+
+      # @!attribute days
+      #   The days of the week to repeat the schedule.
+      #
+      #   @return [Array<Symbol, Knockapi::ScheduleRepeatRule::Day>, nil]
+      optional :days,
+               -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ScheduleRepeatRule::Day] },
+               nil?: true
+
+      # @!attribute hours
+      #   The hour of the day to repeat the schedule.
+      #
+      #   @return [Integer, nil]
+      optional :hours, Integer, nil?: true
+
+      # @!attribute interval
+      #   The interval of the schedule.
+      #
+      #   @return [Integer, nil]
+      optional :interval, Integer
+
+      # @!attribute minutes
+      #   The minute of the hour to repeat the schedule.
+      #
+      #   @return [Integer, nil]
+      optional :minutes, Integer, nil?: true
+
+      # @!method initialize(_typename:, frequency:, day_of_month: nil, days: nil, hours: nil, interval: nil, minutes: nil)
+      #   The repeat rule for the schedule.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param frequency [Symbol, Knockapi::ScheduleRepeatRule::Frequency] The frequency of the schedule.
+      #
+      #   @param day_of_month [Integer, nil] The day of the month to repeat the schedule.
+      #
+      #   @param days [Array<Symbol, Knockapi::ScheduleRepeatRule::Day>, nil] The days of the week to repeat the schedule.
+      #
+      #   @param hours [Integer, nil] The hour of the day to repeat the schedule.
+      #
+      #   @param interval [Integer] The interval of the schedule.
+      #
+      #   @param minutes [Integer, nil] The minute of the hour to repeat the schedule.
+
+      # The frequency of the schedule.
+      #
+      # @see Knockapi::ScheduleRepeatRule#frequency
+      module Frequency
+        extend Knockapi::Internal::Type::Enum
+
+        DAILY = :daily
+        WEEKLY = :weekly
+        MONTHLY = :monthly
+        HOURLY = :hourly
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # An identifier for a day of the week.
+      module Day
+        extend Knockapi::Internal::Type::Enum
+
+        MON = :mon
+        TUE = :tue
+        WED = :wed
+        THU = :thu
+        FRI = :fri
+        SAT = :sat
+        SUN = :sun
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/knockapi/models/schedule_update_params.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Schedules#update
+    class ScheduleUpdateParams < 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]
+
+      # @!attribute actor
+      #   A reference to a recipient, either a user identifier (string) or an object
+      #   reference (ID, collection).
+      #
+      #   @return [String, Knockapi::RecipientReference::ObjectReference, nil]
+      optional :actor, union: -> { Knockapi::RecipientReference }, 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 ending_at
+      #   The ending date and time for the schedule.
+      #
+      #   @return [Time, nil]
+      optional :ending_at, Time, nil?: true
+
+      # @!attribute repeats
+      #   The repeat rule for the schedule.
+      #
+      #   @return [Array<Knockapi::ScheduleRepeatRule>, nil]
+      optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
+
+      # @!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(schedule_ids:, actor: nil, data: nil, ending_at: nil, repeats: nil, scheduled_at: nil, tenant: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::ScheduleUpdateParams} for more details.
+      #
+      #   @param schedule_ids [Array<String>] A list of schedule IDs.
+      #
+      #   @param actor [String, Knockapi::RecipientReference::ObjectReference, nil] A reference to a recipient, either a user identifier (string) or an object refer
+      #
+      #   @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 repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule 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_update_response.rb

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

data/lib/knockapi/models/schedules/bulk_create_params.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    module Schedules
+      # @see Knockapi::Resources::Schedules::Bulk#create
+      class BulkCreateParams < Knockapi::Internal::Type::BaseModel
+        extend Knockapi::Internal::Type::RequestParameters::Converter
+        include Knockapi::Internal::Type::RequestParameters
+
+        # @!attribute schedules
+        #   A list of schedules.
+        #
+        #   @return [Array<Knockapi::Schedules::BulkCreateParams::Schedule>]
+        required :schedules,
+                 -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Schedules::BulkCreateParams::Schedule] }
+
+        # @!method initialize(schedules:, request_options: {})
+        #   @param schedules [Array<Knockapi::Schedules::BulkCreateParams::Schedule>] A list of schedules.
+        #
+        #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+
+        class Schedule < Knockapi::Internal::Type::BaseModel
+          # @!attribute workflow
+          #   The key of the workflow.
+          #
+          #   @return [String]
+          required :workflow, String
+
+          # @!attribute actor
+          #   Specifies a recipient in a request. This can either be a user identifier
+          #   (string), an inline user request (object), or an inline object request, which is
+          #   determined by the presence of a `collection` property.
+          #
+          #   @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
+          optional :actor, union: -> { Knockapi::RecipientRequest }, 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 ending_at
+          #   The ending date and time for the schedule.
+          #
+          #   @return [Time, nil]
+          optional :ending_at, Time, nil?: true
+
+          # @!attribute recipient
+          #   Specifies a recipient in a request. This can either be a user identifier
+          #   (string), an inline user request (object), or an inline object request, which is
+          #   determined by the presence of a `collection` property.
+          #
+          #   @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
+          optional :recipient, union: -> { Knockapi::RecipientRequest }
+
+          # @!attribute repeats
+          #   The repeat rule for the schedule.
+          #
+          #   @return [Array<Knockapi::ScheduleRepeatRule>, nil]
+          optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
+
+          # @!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(workflow:, actor: nil, data: nil, ending_at: nil, recipient: nil, repeats: nil, scheduled_at: nil, tenant: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Knockapi::Schedules::BulkCreateParams::Schedule} for more details.
+          #
+          #   A schedule represents a recurring workflow execution.
+          #
+          #   @param workflow [String] The key of the workflow.
+          #
+          #   @param actor [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
+          #
+          #   @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 recipient [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest] Specifies a recipient in a request. This can either be a user identifier (string
+          #
+          #   @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule 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.
+        end
+      end
+    end
+  end
+end

data/lib/knockapi/models/tenant.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Tenants#list
+    class Tenant < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the tenant.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute _typename
+      #   The typename of the schema.
+      #
+      #   @return [String]
+      required :_typename, String, api_name: :__typename
+
+      # @!attribute name
+      #   An optional name for the tenant.
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!attribute settings
+      #   The settings for the tenant. Includes branding and preference set.
+      #
+      #   @return [Knockapi::Tenant::Settings, nil]
+      optional :settings, -> { Knockapi::Tenant::Settings }, nil?: true
+
+      # @!method initialize(id:, _typename:, name: nil, settings: nil)
+      #   A tenant entity.
+      #
+      #   @param id [String] The unique identifier for the tenant.
+      #
+      #   @param _typename [String] The typename of the schema.
+      #
+      #   @param name [String, nil] An optional name for the tenant.
+      #
+      #   @param settings [Knockapi::Tenant::Settings, nil] The settings for the tenant. Includes branding and preference set.
+
+      # @see Knockapi::Tenant#settings
+      class Settings < Knockapi::Internal::Type::BaseModel
+        # @!attribute branding
+        #   The branding for the tenant.
+        #
+        #   @return [Knockapi::Tenant::Settings::Branding, nil]
+        optional :branding, -> { Knockapi::Tenant::Settings::Branding }, nil?: true
+
+        # @!attribute preference_set
+        #   A preference set represents a specific set of notification preferences for a
+        #   recipient. A recipient can have multiple preference sets.
+        #
+        #   @return [Knockapi::Recipients::PreferenceSet, nil]
+        optional :preference_set, -> { Knockapi::Recipients::PreferenceSet }, nil?: true
+
+        # @!method initialize(branding: nil, preference_set: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Knockapi::Tenant::Settings} for more details.
+        #
+        #   The settings for the tenant. Includes branding and preference set.
+        #
+        #   @param branding [Knockapi::Tenant::Settings::Branding, nil] The branding for the tenant.
+        #
+        #   @param preference_set [Knockapi::Recipients::PreferenceSet, nil] A preference set represents a specific set of notification preferences for a rec
+
+        # @see Knockapi::Tenant::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::Tenant::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/tenant_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Tenants#delete
+    class TenantDeleteParams < 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/tenant_delete_response.rb

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

data/lib/knockapi/models/tenant_get_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Tenants#get
+    class TenantGetParams < 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/tenant_list_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    # @see Knockapi::Resources::Tenants#list
+    class TenantListParams < 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 name
+      #   Filter tenants by name.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute page_size
+      #   The number of items per page.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute tenant_id
+      #   Filter tenants by ID.
+      #
+      #   @return [String, nil]
+      optional :tenant_id, String
+
+      # @!method initialize(after: nil, before: nil, name: nil, page_size: nil, tenant_id: nil, request_options: {})
+      #   @param after [String] The cursor to fetch entries after.
+      #
+      #   @param before [String] The cursor to fetch entries before.
+      #
+      #   @param name [String] Filter tenants by name.
+      #
+      #   @param page_size [Integer] The number of items per page.
+      #
+      #   @param tenant_id [String] Filter tenants by ID.
+      #
+      #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/knockapi/models/tenant_request.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class TenantRequest < Knockapi::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the tenant.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!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::TenantRequest::Settings, nil]
+      optional :settings, -> { Knockapi::TenantRequest::Settings }
+
+      # @!method initialize(id:, channel_data: nil, preferences: nil, settings: nil)
+      #   A tenant to be set in the system. You can supply any additional properties on
+      #   the tenant object.
+      #
+      #   @param id [String] The unique identifier for the tenant.
+      #
+      #   @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::TenantRequest::Settings] The settings for the tenant. Includes branding and preference set.
+
+      # @see Knockapi::TenantRequest#settings
+      class Settings < Knockapi::Internal::Type::BaseModel
+        # @!attribute branding
+        #   The branding for the tenant.
+        #
+        #   @return [Knockapi::TenantRequest::Settings::Branding, nil]
+        optional :branding, -> { Knockapi::TenantRequest::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::TenantRequest::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::TenantRequest::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::TenantRequest::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