knockapi 1.38.0 → 1.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8891830940fce5782b0b440cc905efa67052d23ba10f11a3f07efdae1320728c
-  data.tar.gz: 9cce73907e7b336a894ec466c92855730acf85a35bdf6c2dd563de71a4bcf3ed
+  metadata.gz: cecada7e7f0057e4991554ef65d07d915bb8229a65e35e2a430568d3dde58fd1
+  data.tar.gz: 55334246492961a6b1d80aa2f78ed5968a3326f11d569c32fac46373a09ef623
 SHA512:
-  metadata.gz: cc51f92251ee219fd897569845e1e5489234783e3b159247535956b1be340d6ebe681825d731fe240399c63593f757d364b44fc80de211a9aaa4e45da13fc420
-  data.tar.gz: 5e8fc220fc3ebdba847ab142de05b6185cf2b8ae255a17caeed7ee61a516cec37ba36a0270dcf6850549caf8356b8741a61b453d39cc7cc0497db0bbcf47fc53
+  metadata.gz: 91525a582efc4b5104af222d821832151b5a7547baff85a219f7957bb0a52228d4bf1494f9fb4480146a7b5a48009932da86b23c87db8e96dfafd564e4ee4cde
+  data.tar.gz: 87fbbf00af0259fa59b8a5b969f72487eabf9bdac63668e33b2a875887f69c2309cda1c2910561baa644e2856e8b931d762eb93e72115e1ac248fa184d38c9f5

data/CHANGELOG.md

@@ -1,5 +1,53 @@
 # Changelog
 
+## [1.40.0](https://github.com/knocklabs/knock-ruby/compare/v1.39.0...v1.40.0) (2026-09-03)
+
+
+### Features
+
+* **stlc:** refresh API stainless config with stlc autoconfig ([6efaf18](https://github.com/knocklabs/knock-ruby/commit/6efaf18a4f1175880f796efb38aec623ad04fedd))
+* update api spec to v0.1.1610 ([b65f51e](https://github.com/knocklabs/knock-ruby/commit/b65f51ef1b6ea212c472df607b49edfade13cd1f))
+* update api spec to v0.1.1611 ([7614e38](https://github.com/knocklabs/knock-ruby/commit/7614e383339d5e96f56799bffd97b497df002b3a))
+* update api spec to v0.1.1614 ([b57ec7b](https://github.com/knocklabs/knock-ruby/commit/b57ec7b41caae97b5e5d4aa41fa5bf51fbb76889))
+* update api spec to v0.1.1616 ([ff707e6](https://github.com/knocklabs/knock-ruby/commit/ff707e6c26c86dd0b79fcac7257bd144fc091a73))
+* update api spec to v0.1.1617 ([80db750](https://github.com/knocklabs/knock-ruby/commit/80db7504ef6a32a6c5ce55514f183674f3843a64))
+* update api spec to v0.1.1618 ([999a5d9](https://github.com/knocklabs/knock-ruby/commit/999a5d92b7e831879cf27a68685d33a1e776ed51))
+* update api spec to v0.1.1624 ([e1c5286](https://github.com/knocklabs/knock-ruby/commit/e1c5286dc8d174c08afd44b7358cc383884f46d9))
+* update api spec to v0.1.1627 ([7a2f372](https://github.com/knocklabs/knock-ruby/commit/7a2f372d0516ca4635ed9358bb1bbaf705c9af07))
+* update api spec to v0.1.1629 ([a01f51c](https://github.com/knocklabs/knock-ruby/commit/a01f51c838bca069dd30057eb4e84b7d9b3d6441))
+* update api spec to v0.1.1630 ([5396e07](https://github.com/knocklabs/knock-ruby/commit/5396e0752bca5be56746740aecf3cd962c616669))
+* update api spec to v0.1.1631 ([24de0a8](https://github.com/knocklabs/knock-ruby/commit/24de0a8cf2022c675c5aef0043f4eaead6ae7452))
+* update api spec to v0.1.1632 ([8010be1](https://github.com/knocklabs/knock-ruby/commit/8010be1ae272dc56131fe1e99acf9687ac7bd30e))
+* update api spec to v0.1.1636 ([a19fe99](https://github.com/knocklabs/knock-ruby/commit/a19fe996f3f234355acc4d222a4839ee31a5dd49))
+* update api spec to v0.1.1640 ([82e0daa](https://github.com/knocklabs/knock-ruby/commit/82e0daa9e78471abf3c10a594cf64ec4a84f2354))
+* update api spec to v0.1.1641 ([b75f252](https://github.com/knocklabs/knock-ruby/commit/b75f25223c96db4665dfaec7f94e0dbe10b6ee47))
+* update api spec to v0.1.1642 ([f939368](https://github.com/knocklabs/knock-ruby/commit/f939368e531addc3cb0ca7c2574f22e5556cd7eb))
+* update api spec to v0.1.1644 ([d97f09e](https://github.com/knocklabs/knock-ruby/commit/d97f09e7d86ddb2dd93ecc0ffe56dca00f4e3b96))
+* update api spec to v0.1.1649 ([fea5008](https://github.com/knocklabs/knock-ruby/commit/fea50086b5a0dab94bc10f38e4220f7789e9556a))
+* update api spec to v0.1.1651 ([0cced42](https://github.com/knocklabs/knock-ruby/commit/0cced425d2a221aecb9f48445d87f50f9adf1458))
+* update api spec to v0.1.1661 ([96b1707](https://github.com/knocklabs/knock-ruby/commit/96b170796a5ed2ddd9aafbbe5e3e93c7ba785fcc))
+* update api spec to v0.1.1662 ([1036db0](https://github.com/knocklabs/knock-ruby/commit/1036db0b2fcff875ed192b8a70a5cf22dbb87ae6))
+* update api spec to v0.1.1664 ([bbd19f1](https://github.com/knocklabs/knock-ruby/commit/bbd19f1d3f0db78120fdc7254ea494be4f17154d))
+* update api spec to v0.1.1683 ([b30cd0b](https://github.com/knocklabs/knock-ruby/commit/b30cd0b5d4ce60d177f81d8990c0c4de12d52c0d))
+* update api spec to v0.1.1686 ([b8222be](https://github.com/knocklabs/knock-ruby/commit/b8222bed86c35edf2637c9d6cc076da775f00e65))
+* update api spec to v0.1.1687 ([9468daa](https://github.com/knocklabs/knock-ruby/commit/9468daa27c0c622266151a4511907feeaca920d5))
+
+## [1.39.0](https://github.com/knocklabs/knock-ruby/compare/v1.38.0...v1.39.0) (2026-07-21)
+
+
+### Features
+
+* update api spec to v0.1.1599 ([e087beb](https://github.com/knocklabs/knock-ruby/commit/e087beb49fb56d8fbf123858163008c4e98dc984))
+* update api spec to v0.1.1605 ([31ddc3e](https://github.com/knocklabs/knock-ruby/commit/31ddc3e8e474b11a8df37e05fff603e4e34b28c8))
+* update api spec to v0.1.1607 ([3b5254e](https://github.com/knocklabs/knock-ruby/commit/3b5254e4f12c10a447d7ca5fbfd5a9a4d5af15c1))
+* update api spec to v0.1.1608 ([a76e7b2](https://github.com/knocklabs/knock-ruby/commit/a76e7b2aa80265a5f701374aa06c3c447be44825))
+* update api spec to v0.1.1609 ([4f22935](https://github.com/knocklabs/knock-ruby/commit/4f22935b2198ff54a122a7843cec9eec93602881))
+
+
+### Chores
+
+* forward SDK_WRITE_TOKEN to the back-sync workflow ([b79c2b9](https://github.com/knocklabs/knock-ruby/commit/b79c2b9bfb80b385fcdf312cee231b6fd6d25f84))
+
 ## [1.38.0](https://github.com/knocklabs/knock-ruby/compare/v1.37.0...v1.38.0) (2026-07-16)
 
 

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.38.0"
+gem "knockapi", "~> 1.40.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/knockapi/models/audience_add_members_params.rb

@@ -15,8 +15,8 @@ module Knockapi
       # @!attribute members
       #   A list of audience members to add. You can add up to 1,000 members per request.
       #
-      #   @return [Array<Knockapi::Models::AudienceAddMembersParams::Member>]
-      required :members, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceAddMembersParams::Member] }
+      #   @return [Array<Knockapi::Models::AudienceMemberRequest>]
+      required :members, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceMemberRequest] }
 
       # @!attribute create_audience
       #   Create the audience if it does not exist.
@@ -27,38 +27,11 @@ module Knockapi
       # @!method initialize(key:, members:, create_audience: nil, request_options: {})
       #   @param key [String]
       #
-      #   @param members [Array<Knockapi::Models::AudienceAddMembersParams::Member>] A list of audience members to add. You can add up to 1,000 members per request.
+      #   @param members [Array<Knockapi::Models::AudienceMemberRequest>] A list of audience members to add. You can add up to 1,000 members per request.
       #
       #   @param create_audience [Boolean] Create the audience if it does not exist.
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
-
-      class Member < Knockapi::Internal::Type::BaseModel
-        # @!attribute user
-        #   A set of parameters to inline-identify a user with. Inline identifying the user
-        #   will ensure that the user is available before the request is executed in Knock.
-        #   It will perform an upsert for the user you're supplying, replacing any
-        #   properties specified.
-        #
-        #   @return [Knockapi::Models::InlineIdentifyUserRequest]
-        required :user, -> { Knockapi::InlineIdentifyUserRequest }
-
-        # @!attribute tenant
-        #   The unique identifier for the tenant.
-        #
-        #   @return [String, nil]
-        optional :tenant, String, nil?: true
-
-        # @!method initialize(user:, tenant: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Knockapi::Models::AudienceAddMembersParams::Member} for more details.
-        #
-        #   An audience member.
-        #
-        #   @param user [Knockapi::Models::InlineIdentifyUserRequest] A set of parameters to inline-identify a user with. Inline identifying the user
-        #
-        #   @param tenant [String, nil] The unique identifier for the tenant.
-      end
     end
   end
 end

data/lib/knockapi/models/audience_member_request.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class AudienceMemberRequest < Knockapi::Internal::Type::BaseModel
+      # @!attribute user
+      #   A set of parameters to inline-identify a user with. Inline identifying the user
+      #   will ensure that the user is available before the request is executed in Knock.
+      #   It will perform an upsert for the user you're supplying, replacing any
+      #   properties specified.
+      #
+      #   @return [Knockapi::Models::InlineIdentifyUserRequest]
+      required :user, -> { Knockapi::InlineIdentifyUserRequest }
+
+      # @!attribute tenant
+      #   The unique identifier for the tenant.
+      #
+      #   @return [String, nil]
+      optional :tenant, String, nil?: true
+
+      # @!method initialize(user:, tenant: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Knockapi::Models::AudienceMemberRequest} for more details.
+      #
+      #   An audience member.
+      #
+      #   @param user [Knockapi::Models::InlineIdentifyUserRequest] A set of parameters to inline-identify a user with. Inline identifying the user
+      #
+      #   @param tenant [String, nil] The unique identifier for the tenant.
+    end
+  end
+end

data/lib/knockapi/models/audience_remove_members_params.rb

@@ -16,8 +16,8 @@ module Knockapi
       #   A list of audience members to remove. You can remove up to 1,000 members per
       #   request.
       #
-      #   @return [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>]
-      required :members, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceRemoveMembersParams::Member] }
+      #   @return [Array<Knockapi::Models::AudienceMemberRequest>]
+      required :members, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceMemberRequest] }
 
       # @!method initialize(key:, members:, request_options: {})
       #   Some parameter documentations has been truncated, see
@@ -25,36 +25,9 @@ module Knockapi
       #
       #   @param key [String]
       #
-      #   @param members [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>] A list of audience members to remove. You can remove up to 1,000 members per req
+      #   @param members [Array<Knockapi::Models::AudienceMemberRequest>] A list of audience members to remove. You can remove up to 1,000 members per req
       #
       #   @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
-
-      class Member < Knockapi::Internal::Type::BaseModel
-        # @!attribute user
-        #   A set of parameters to inline-identify a user with. Inline identifying the user
-        #   will ensure that the user is available before the request is executed in Knock.
-        #   It will perform an upsert for the user you're supplying, replacing any
-        #   properties specified.
-        #
-        #   @return [Knockapi::Models::InlineIdentifyUserRequest]
-        required :user, -> { Knockapi::InlineIdentifyUserRequest }
-
-        # @!attribute tenant
-        #   The unique identifier for the tenant.
-        #
-        #   @return [String, nil]
-        optional :tenant, String, nil?: true
-
-        # @!method initialize(user:, tenant: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Knockapi::Models::AudienceRemoveMembersParams::Member} for more details.
-        #
-        #   An audience member.
-        #
-        #   @param user [Knockapi::Models::InlineIdentifyUserRequest] A set of parameters to inline-identify a user with. Inline identifying the user
-        #
-        #   @param tenant [String, nil] The unique identifier for the tenant.
-      end
     end
   end
 end

data/lib/knockapi/models/list_messages_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class ListMessagesResponse < Knockapi::Internal::Type::BaseModel
+      # @!attribute items
+      #   A list of messages.
+      #
+      #   @return [Array<Knockapi::Models::Message>]
+      required :items, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Message] }
+
+      # @!attribute page_info
+      #   Pagination information for a list of resources.
+      #
+      #   @return [Knockapi::Models::PageInfo]
+      required :page_info, -> { Knockapi::PageInfo }
+
+      # @!method initialize(items:, page_info:)
+      #   A paginated list of messages.
+      #
+      #   @param items [Array<Knockapi::Models::Message>] A list of messages.
+      #
+      #   @param page_info [Knockapi::Models::PageInfo] Pagination information for a list of resources.
+    end
+  end
+end

data/lib/knockapi/models/list_schedules_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class ListSchedulesResponse < Knockapi::Internal::Type::BaseModel
+      # @!attribute entries
+      #   A list of schedules.
+      #
+      #   @return [Array<Knockapi::Models::Schedule>]
+      required :entries, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Schedule] }
+
+      # @!attribute page_info
+      #   Pagination information for a list of resources.
+      #
+      #   @return [Knockapi::Models::PageInfo]
+      required :page_info, -> { Knockapi::PageInfo }
+
+      # @!method initialize(entries:, page_info:)
+      #   A response containing a list of schedules.
+      #
+      #   @param entries [Array<Knockapi::Models::Schedule>] A list of schedules.
+      #
+      #   @param page_info [Knockapi::Models::PageInfo] Pagination information for a list of resources.
+    end
+  end
+end

data/lib/knockapi/models/list_subscriptions_response.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Knockapi
+  module Models
+    class ListSubscriptionsResponse < Knockapi::Internal::Type::BaseModel
+      # @!attribute entries
+      #   A list of subscriptions.
+      #
+      #   @return [Array<Knockapi::Models::Recipients::Subscription>]
+      required :entries, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::Subscription] }
+
+      # @!attribute page_info
+      #   Pagination information for a list of resources.
+      #
+      #   @return [Knockapi::Models::PageInfo]
+      required :page_info, -> { Knockapi::PageInfo }
+
+      # @!method initialize(entries:, page_info:)
+      #   A response containing a list of subscriptions.
+      #
+      #   @param entries [Array<Knockapi::Models::Recipients::Subscription>] A list of subscriptions.
+      #
+      #   @param page_info [Knockapi::Models::PageInfo] Pagination information for a list of resources.
+    end
+  end
+end

data/lib/knockapi/models/message.rb

@@ -123,8 +123,9 @@ module Knockapi
       optional :read_at, Time, nil?: true
 
       # @!attribute recipient_snapshot
-      #   Recipient contact information captured at email send time. Null for non-email
-      #   channels.
+      #   The destination the message was delivered to, captured at send time. Email
+      #   channels carry `email`/`name`; chat channels carry the destination `channel_id`
+      #   or `user_id`, or `via_incoming_webhook`. Null when no snapshot was captured.
       #
       #   @return [Knockapi::Models::Message::RecipientSnapshot, nil]
       optional :recipient_snapshot, -> { Knockapi::Message::RecipientSnapshot }, nil?: true
@@ -199,7 +200,7 @@ module Knockapi
       #
       #   @param read_at [Time, nil] Timestamp when the message was read.
       #
-      #   @param recipient_snapshot [Knockapi::Models::Message::RecipientSnapshot, nil] Recipient contact information captured at email send time. Null for non-email ch
+      #   @param recipient_snapshot [Knockapi::Models::Message::RecipientSnapshot, nil] The destination the message was delivered to, captured at send time. Email chann
       #
       #   @param scheduled_at [Time, nil] Timestamp when the message was scheduled to be sent.
       #
@@ -413,25 +414,50 @@ module Knockapi
 
       # @see Knockapi::Models::Message#recipient_snapshot
       class RecipientSnapshot < Knockapi::Internal::Type::BaseModel
+        # @!attribute channel_id
+        #   The chat channel the message was delivered to (chat channels)
+        #
+        #   @return [String, nil]
+        optional :channel_id, String, nil?: true
+
         # @!attribute email
-        #   The email address the message was delivered to
+        #   The email address the message was delivered to (email channels)
         #
         #   @return [String, nil]
-        optional :email, String
+        optional :email, String, nil?: true
 
         # @!attribute name
-        #   The recipient name at send time
+        #   The recipient name at send time (email channels)
         #
         #   @return [String, nil]
         optional :name, String, nil?: true
 
-        # @!method initialize(email: nil, name: nil)
-        #   Recipient contact information captured at email send time. Null for non-email
-        #   channels.
+        # @!attribute user_id
+        #   The chat user the message was direct-messaged to (chat channels)
+        #
+        #   @return [String, nil]
+        optional :user_id, String, nil?: true
+
+        # @!attribute via_incoming_webhook
+        #   Whether the chat message was delivered via an incoming webhook
+        #
+        #   @return [Boolean, nil]
+        optional :via_incoming_webhook, Knockapi::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(channel_id: nil, email: nil, name: nil, user_id: nil, via_incoming_webhook: nil)
+        #   The destination the message was delivered to, captured at send time. Email
+        #   channels carry `email`/`name`; chat channels carry the destination `channel_id`
+        #   or `user_id`, or `via_incoming_webhook`. Null when no snapshot was captured.
+        #
+        #   @param channel_id [String, nil] The chat channel the message was delivered to (chat channels)
+        #
+        #   @param email [String, nil] The email address the message was delivered to (email channels)
+        #
+        #   @param name [String, nil] The recipient name at send time (email channels)
         #
-        #   @param email [String] The email address the message was delivered to
+        #   @param user_id [String, nil] The chat user the message was direct-messaged to (chat channels)
         #
-        #   @param name [String, nil] The recipient name at send time
+        #   @param via_incoming_webhook [Boolean, nil] Whether the chat message was delivered via an incoming webhook
       end
     end
   end