knockapi 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05e2af454cc4e2dc3f721acdafcfe91ff2aafaac9a6cdcaeff7a6d0fb3554ded
-  data.tar.gz: 51f60b06a643f43661372498e05cf0eb236f9b05f290816ecf8c2d36450c84cd
+  metadata.gz: 2d5f3a2c6174ea9d6f4a8203b2dc98ec7edfb5374cffd899a0b6b669257a7686
+  data.tar.gz: 2b4c45abf3420222039f6caacf508a530c4c8cac4196e325c353f927f60e5b6c
 SHA512:
-  metadata.gz: 4664831a9ed4bb37eff4922c9bc1d75d08db467e03e1e70f97b7584ca20f5fd534a90a05c29dca71413c8cf9d782e954b4b6cddab94fba14f68f42820173dc25
-  data.tar.gz: d9353f602163c8883a97a072755294bde85439126a986dc1c8148daca0f7e92965836e146fe4df9591205284b86b1abf04c1166a97461ecc52887d030c7c7696
+  metadata.gz: '0409be38f4fe4c66806657b1821f9bd66f4191a5c631cbbd6110c4ab60a7d3b3613c6fa8909656b85dfd99723f953172a4561d7a5addb8fdc61aa00882ea71a1'
+  data.tar.gz: 8bb6ec2864fa22a0482c4600d911fbd4e7d38c6e4b58b0c6f7f71163781d588fb8d1bd674a0bbd4c6dd1e399ed43c5f930b73c407636b5b6fae443dd5e5fbd74

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 1.5.0 (2025-06-04)
+
+Full Changelog: [v1.4.0...v1.5.0](https://github.com/knocklabs/knock-ruby/compare/v1.4.0...v1.5.0)
+
+### Features
+
+* **api:** api update ([b4a8a6f](https://github.com/knocklabs/knock-ruby/commit/b4a8a6f6bd5451fb68be75c19b5b08b7629543cc))
+
+
+### Bug Fixes
+
+* `to_sorbet_type` should not return branded types ([2fe0597](https://github.com/knocklabs/knock-ruby/commit/2fe05973673d02ced0a04abc32f0ea079ff9313f))
+
+## 1.4.0 (2025-05-29)
+
+Full Changelog: [v1.3.0...v1.4.0](https://github.com/knocklabs/knock-ruby/compare/v1.3.0...v1.4.0)
+
+### Features
+
+* **api:** api update ([f1d1f0f](https://github.com/knocklabs/knock-ruby/commit/f1d1f0f262a0cecec5f416873be4d3ee6418ec94))
+
 ## 1.3.0 (2025-05-28)
 
 Full Changelog: [v1.2.0...v1.3.0](https://github.com/knocklabs/knock-ruby/compare/v1.2.0...v1.3.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "knockapi", "~> 1.3.0"
+gem "knockapi", "~> 1.5.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/knockapi/internal/type/enum.rb

@@ -91,11 +91,14 @@ module Knockapi
         #
         # @return [Object]
         def to_sorbet_type
-          case values
+          types = values.map { Knockapi::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq
+          case types
           in []
             T.noreturn
-          in [value, *_]
-            T.all(Knockapi::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(value), self)
+          in [type]
+            type
+          else
+            T.any(*types)
           end
         end
 

data/lib/knockapi/internal/type/union.rb

@@ -206,11 +206,14 @@ module Knockapi
         #
         # @return [Object]
         def to_sorbet_type
-          case (v = variants)
+          types = variants.map { Knockapi::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) }.uniq
+          case types
           in []
             T.noreturn
+          in [type]
+            type
           else
-            T.any(*v.map { Knockapi::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(_1) })
+            T.any(*types)
           end
         end
 

data/lib/knockapi/models/schedule_create_params.rb

@@ -13,18 +13,20 @@ module Knockapi
       #   @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
       required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
 
-      # @!attribute repeats
-      #   The repeat rule for the schedule.
-      #
-      #   @return [Array<Knockapi::Models::ScheduleRepeatRule>]
-      required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
-
       # @!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::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil]
+      optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true
+
       # @!attribute data
       #   An optional map of data to pass into the workflow execution. There is a 1024
       #   byte limit on the size of any single string value (with the exception of
@@ -40,6 +42,12 @@ module Knockapi
       #   @return [Time, nil]
       optional :ending_at, Time, nil?: true
 
+      # @!attribute repeats
+      #   The repeat rule for the schedule.
+      #
+      #   @return [Array<Knockapi::Models::ScheduleRepeatRule>, nil]
+      optional :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
+
       # @!attribute scheduled_at
       #   The starting date and time for the schedule.
       #
@@ -52,20 +60,22 @@ module Knockapi
       #   @return [String, Knockapi::Models::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: {})
+      # @!method initialize(recipients:, workflow:, 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::ScheduleCreateParams} for more details.
       #
       #   @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to set the schedule for. Limited to 100 recipients per request.
       #
-      #   @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
-      #
       #   @param workflow [String] The key of the workflow.
       #
+      #   @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::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. There is a 1024 byt
       #
       #   @param ending_at [Time, nil] The ending date and time for the schedule.
       #
+      #   @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
+      #
       #   @param scheduled_at [Time, nil] The starting date and time for the schedule.
       #
       #   @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.

data/lib/knockapi/models.rb

@@ -11,16 +11,16 @@ module Knockapi
       mod.constants.each do |name|
         case mod.const_get(name)
         in true | false
-          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, mod) } }
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
           mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
         in Integer
-          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, mod) } }
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
           mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
         in Float
-          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, mod) } }
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
           mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
         in Symbol
-          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, mod) } }
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
           mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
         else
         end

data/lib/knockapi/resources/schedules.rb

@@ -15,18 +15,20 @@ module Knockapi
       # [inline identifications](/managing-recipients/identifying-recipients#inline-identifying-recipients)
       # for the `actor`, `recipient`, and `tenant` fields.
       #
-      # @overload create(recipients:, repeats:, workflow:, data: nil, ending_at: nil, scheduled_at: nil, tenant: nil, request_options: {})
+      # @overload create(recipients:, workflow:, actor: nil, data: nil, ending_at: nil, repeats: nil, scheduled_at: nil, tenant: nil, request_options: {})
       #
       # @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to set the schedule for. Limited to 100 recipients per request.
       #
-      # @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
-      #
       # @param workflow [String] The key of the workflow.
       #
+      # @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::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. There is a 1024 byt
       #
       # @param ending_at [Time, nil] The ending date and time for the schedule.
       #
+      # @param repeats [Array<Knockapi::Models::ScheduleRepeatRule>] The repeat rule for the schedule.
+      #
       # @param scheduled_at [Time, nil] The starting date and time for the schedule.
       #
       # @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.

data/lib/knockapi/resources/users.rb

@@ -344,7 +344,9 @@ module Knockapi
         )
       end
 
-      # Updates or creates channel data for a specific user and channel ID.
+      # Updates or creates channel data for a specific user and channel ID. If no user
+      # exists in the current environment for the given `user_id`, Knock will create the
+      # user entry as part of this request.
       #
       # @overload set_channel_data(user_id, channel_id, data:, request_options: {})
       #

data/lib/knockapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knockapi
-  VERSION = "1.3.0"
+  VERSION = "1.5.0"
 end

data/rbi/knockapi/models/schedule_create_params.rbi

@@ -25,14 +25,26 @@ module Knockapi
       end
       attr_accessor :recipients
 
-      # The repeat rule for the schedule.
-      sig { returns(T::Array[Knockapi::ScheduleRepeatRule]) }
-      attr_accessor :repeats
-
       # The key of the workflow.
       sig { returns(String) }
       attr_accessor :workflow
 
+      # 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.
+      sig do
+        returns(
+          T.nilable(
+            T.any(
+              String,
+              Knockapi::InlineIdentifyUserRequest,
+              Knockapi::InlineObjectRequest
+            )
+          )
+        )
+      end
+      attr_accessor :actor
+
       # An optional map of data to pass into the workflow execution. There is a 1024
       # byte limit on the size of any single string value (with the exception of
       # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
@@ -44,6 +56,15 @@ module Knockapi
       sig { returns(T.nilable(Time)) }
       attr_accessor :ending_at
 
+      # The repeat rule for the schedule.
+      sig { returns(T.nilable(T::Array[Knockapi::ScheduleRepeatRule])) }
+      attr_reader :repeats
+
+      sig do
+        params(repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash]).void
+      end
+      attr_writer :repeats
+
       # The starting date and time for the schedule.
       sig { returns(T.nilable(Time)) }
       attr_accessor :scheduled_at
@@ -62,10 +83,18 @@ module Knockapi
                 Knockapi::InlineObjectRequest::OrHash
               )
             ],
-          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           workflow: String,
+          actor:
+            T.nilable(
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ),
           data: T.nilable(T::Hash[Symbol, T.anything]),
           ending_at: T.nilable(Time),
+          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           scheduled_at: T.nilable(Time),
           tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
           request_options: Knockapi::RequestOptions::OrHash
@@ -74,10 +103,12 @@ module Knockapi
       def self.new(
         # The recipients to set the schedule for. Limited to 100 recipients per request.
         recipients:,
-        # The repeat rule for the schedule.
-        repeats:,
         # The key of the workflow.
         workflow:,
+        # 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.
+        actor: nil,
         # An optional map of data to pass into the workflow execution. There is a 1024
         # byte limit on the size of any single string value (with the exception of
         # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
@@ -85,6 +116,8 @@ module Knockapi
         data: nil,
         # The ending date and time for the schedule.
         ending_at: nil,
+        # The repeat rule for the schedule.
+        repeats: nil,
         # The starting date and time for the schedule.
         scheduled_at: nil,
         # An request to set a tenant inline.
@@ -104,10 +137,18 @@ module Knockapi
                   Knockapi::InlineObjectRequest
                 )
               ],
-            repeats: T::Array[Knockapi::ScheduleRepeatRule],
             workflow: String,
+            actor:
+              T.nilable(
+                T.any(
+                  String,
+                  Knockapi::InlineIdentifyUserRequest,
+                  Knockapi::InlineObjectRequest
+                )
+              ),
             data: T.nilable(T::Hash[Symbol, T.anything]),
             ending_at: T.nilable(Time),
+            repeats: T::Array[Knockapi::ScheduleRepeatRule],
             scheduled_at: T.nilable(Time),
             tenant: T.nilable(T.any(String, Knockapi::TenantRequest)),
             request_options: Knockapi::RequestOptions

data/rbi/knockapi/resources/schedules.rbi

@@ -21,10 +21,18 @@ module Knockapi
                 Knockapi::InlineObjectRequest::OrHash
               )
             ],
-          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           workflow: String,
+          actor:
+            T.nilable(
+              T.any(
+                String,
+                Knockapi::InlineIdentifyUserRequest::OrHash,
+                Knockapi::InlineObjectRequest::OrHash
+              )
+            ),
           data: T.nilable(T::Hash[Symbol, T.anything]),
           ending_at: T.nilable(Time),
+          repeats: T::Array[Knockapi::ScheduleRepeatRule::OrHash],
           scheduled_at: T.nilable(Time),
           tenant: T.nilable(T.any(String, Knockapi::TenantRequest::OrHash)),
           request_options: Knockapi::RequestOptions::OrHash
@@ -33,10 +41,12 @@ module Knockapi
       def create(
         # The recipients to set the schedule for. Limited to 100 recipients per request.
         recipients:,
-        # The repeat rule for the schedule.
-        repeats:,
         # The key of the workflow.
         workflow:,
+        # 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.
+        actor: nil,
         # An optional map of data to pass into the workflow execution. There is a 1024
         # byte limit on the size of any single string value (with the exception of
         # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
@@ -44,6 +54,8 @@ module Knockapi
         data: nil,
         # The ending date and time for the schedule.
         ending_at: nil,
+        # The repeat rule for the schedule.
+        repeats: nil,
         # The starting date and time for the schedule.
         scheduled_at: nil,
         # An request to set a tenant inline.

data/rbi/knockapi/resources/users.rbi

@@ -325,7 +325,9 @@ module Knockapi
       )
       end
 
-      # Updates or creates channel data for a specific user and channel ID.
+      # Updates or creates channel data for a specific user and channel ID. If no user
+      # exists in the current environment for the given `user_id`, Knock will create the
+      # user entry as part of this request.
       sig do
         params(
           user_id: String,

data/sig/knockapi/models/schedule_create_params.rbs

@@ -3,10 +3,11 @@ module Knockapi
     type schedule_create_params =
       {
         recipients: ::Array[Knockapi::Models::recipient_request],
-        repeats: ::Array[Knockapi::ScheduleRepeatRule],
         workflow: String,
+        actor: Knockapi::Models::recipient_request?,
         data: ::Hash[Symbol, top]?,
         ending_at: Time?,
+        repeats: ::Array[Knockapi::ScheduleRepeatRule],
         scheduled_at: Time?,
         tenant: Knockapi::Models::inline_tenant_request?
       }
@@ -18,24 +19,31 @@ module Knockapi
 
       attr_accessor recipients: ::Array[Knockapi::Models::recipient_request]
 
-      attr_accessor repeats: ::Array[Knockapi::ScheduleRepeatRule]
-
       attr_accessor workflow: String
 
+      attr_accessor actor: Knockapi::Models::recipient_request?
+
       attr_accessor data: ::Hash[Symbol, top]?
 
       attr_accessor ending_at: Time?
 
+      attr_reader repeats: ::Array[Knockapi::ScheduleRepeatRule]?
+
+      def repeats=: (
+        ::Array[Knockapi::ScheduleRepeatRule]
+      ) -> ::Array[Knockapi::ScheduleRepeatRule]
+
       attr_accessor scheduled_at: Time?
 
       attr_accessor tenant: Knockapi::Models::inline_tenant_request?
 
       def initialize: (
         recipients: ::Array[Knockapi::Models::recipient_request],
-        repeats: ::Array[Knockapi::ScheduleRepeatRule],
         workflow: String,
+        ?actor: Knockapi::Models::recipient_request?,
         ?data: ::Hash[Symbol, top]?,
         ?ending_at: Time?,
+        ?repeats: ::Array[Knockapi::ScheduleRepeatRule],
         ?scheduled_at: Time?,
         ?tenant: Knockapi::Models::inline_tenant_request?,
         ?request_options: Knockapi::request_opts
@@ -43,10 +51,11 @@ module Knockapi
 
       def to_hash: -> {
         recipients: ::Array[Knockapi::Models::recipient_request],
-        repeats: ::Array[Knockapi::ScheduleRepeatRule],
         workflow: String,
+        actor: Knockapi::Models::recipient_request?,
         data: ::Hash[Symbol, top]?,
         ending_at: Time?,
+        repeats: ::Array[Knockapi::ScheduleRepeatRule],
         scheduled_at: Time?,
         tenant: Knockapi::Models::inline_tenant_request?,
         request_options: Knockapi::RequestOptions

data/sig/knockapi/resources/schedules.rbs

@@ -5,10 +5,11 @@ module Knockapi
 
       def create: (
         recipients: ::Array[Knockapi::Models::recipient_request],
-        repeats: ::Array[Knockapi::ScheduleRepeatRule],
         workflow: String,
+        ?actor: Knockapi::Models::recipient_request?,
         ?data: ::Hash[Symbol, top]?,
         ?ending_at: Time?,
+        ?repeats: ::Array[Knockapi::ScheduleRepeatRule],
         ?scheduled_at: Time?,
         ?tenant: Knockapi::Models::inline_tenant_request?,
         ?request_options: Knockapi::request_opts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knockapi
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Knock
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-29 00:00:00.000000000 Z
+date: 2025-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool