From ed2ca0f0d3d587b2fca1ff4a0fb3dcfec7b67b75 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 3 Sep 2025 15:16:40 +0000 Subject: [PATCH 1/6] feat(api): api update --- .stats.yml | 4 +- lib/knockapi/models/message.rb | 130 ++++++++-------- rbi/knockapi/models/message.rbi | 188 ++++++++++++++--------- sig/knockapi/models/message.rbs | 98 +++++++----- test/knockapi/resources/messages_test.rb | 162 +++++++++---------- test/knockapi/resources/objects_test.rb | 18 +-- test/knockapi/resources/users_test.rb | 18 +-- 7 files changed, 339 insertions(+), 279 deletions(-) diff --git a/.stats.yml b/.stats.yml index 9cbdb2d3..232dd9da 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 89 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-8d6bb1a0b221b8b9fb9aae94419c46e2e1ca4732281924f24c6539c006d12cb8.yml -openapi_spec_hash: 5dd6c9f3cac4f8cc602c0d1543ec4de4 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-e4ea1ded040ebfa923df0d24ef37ae3c742383828cda85e1489bc2cb5e14da29.yml +openapi_spec_hash: 4cfd1f5f0d42e1b821f70ba12089b606 config_hash: 5c872aa99cad9b9602e84668f5b38a8a diff --git a/lib/knockapi/models/message.rb b/lib/knockapi/models/message.rb index 251af541..7c567650 100644 --- a/lib/knockapi/models/message.rb +++ b/lib/knockapi/models/message.rb @@ -7,58 +7,14 @@ class Message < Knockapi::Internal::Type::BaseModel # @!attribute id # The unique identifier for the message. # - # @return [String] - required :id, String + # @return [String, nil] + optional :id, String # @!attribute _typename # The typename of the schema. # - # @return [String] - required :_typename, String, api_name: :__typename - - # @!attribute channel_id - # The ID for the channel the message was sent through. - # - # @return [String] - required :channel_id, String - - # @!attribute engagement_statuses - # A list of engagement statuses. - # - # @return [Array] - required :engagement_statuses, - -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus] } - - # @!attribute inserted_at - # Timestamp when the resource was created. - # - # @return [Time] - required :inserted_at, Time - - # @!attribute recipient - # A reference to a recipient, either a user identifier (string) or an object - # reference (ID, collection). - # - # @return [String, Knockapi::Models::RecipientReference::ObjectReference] - required :recipient, union: -> { Knockapi::RecipientReference } - - # @!attribute source - # The workflow that triggered the message. - # - # @return [Knockapi::Models::Message::Source] - required :source, -> { Knockapi::Message::Source } - - # @!attribute status - # The message delivery status. - # - # @return [Symbol, Knockapi::Models::Message::Status] - required :status, enum: -> { Knockapi::Message::Status } - - # @!attribute updated_at - # The timestamp when the resource was last updated. - # - # @return [Time] - required :updated_at, Time + # @return [String, nil] + optional :_typename, String, api_name: :__typename # @!attribute actors # One or more actors that are associated with this message. Note: this is a list @@ -74,6 +30,12 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [Time, nil] optional :archived_at, Time, nil?: true + # @!attribute channel_id + # The ID for the channel the message was sent through. + # + # @return [String, nil] + optional :channel_id, String + # @!attribute clicked_at # Timestamp when the message was clicked. # @@ -90,6 +52,19 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [Hash{Symbol=>Object}, nil] optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true + # @!attribute engagement_statuses + # A list of engagement statuses. + # + # @return [Array, nil] + optional :engagement_statuses, + -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus] } + + # @!attribute inserted_at + # Timestamp when the resource was created. + # + # @return [Time, nil] + optional :inserted_at, Time + # @!attribute interacted_at # Timestamp when the message was interacted with. # @@ -114,6 +89,13 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [Time, nil] optional :read_at, Time, nil?: true + # @!attribute recipient + # A reference to a recipient, either a user identifier (string) or an object + # reference (ID, collection). + # + # @return [String, Knockapi::Models::RecipientReference::ObjectReference, nil] + optional :recipient, union: -> { Knockapi::RecipientReference } + # @!attribute scheduled_at # Timestamp when the message was scheduled to be sent. # @@ -126,6 +108,18 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [Time, nil] optional :seen_at, Time, nil?: true + # @!attribute source + # The workflow that triggered the message. + # + # @return [Knockapi::Models::Message::Source, nil] + optional :source, -> { Knockapi::Message::Source } + + # @!attribute status + # The message delivery status. + # + # @return [Symbol, Knockapi::Models::Message::Status, nil] + optional :status, enum: -> { Knockapi::Message::Status } + # @!attribute tenant # The ID of the `tenant` associated with the message. Only present when a `tenant` # is provided on a workflow trigger request. @@ -133,6 +127,12 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [String, nil] optional :tenant, String, nil?: true + # @!attribute updated_at + # The timestamp when the resource was last updated. + # + # @return [Time, nil] + optional :updated_at, Time + # @!attribute workflow # @deprecated # @@ -141,7 +141,7 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [String, nil] optional :workflow, String, nil?: true - # @!method initialize(id:, _typename:, channel_id:, engagement_statuses:, inserted_at:, recipient:, source:, status:, updated_at:, actors: nil, archived_at: nil, clicked_at: nil, data: nil, interacted_at: nil, link_clicked_at: nil, metadata: nil, read_at: nil, scheduled_at: nil, seen_at: nil, tenant: nil, workflow: nil) + # @!method initialize(id: nil, _typename: nil, actors: nil, archived_at: nil, channel_id: nil, clicked_at: nil, data: nil, engagement_statuses: nil, inserted_at: nil, interacted_at: nil, link_clicked_at: nil, metadata: nil, read_at: nil, recipient: nil, scheduled_at: nil, seen_at: nil, source: nil, status: nil, tenant: nil, updated_at: nil, workflow: nil) # Some parameter documentations has been truncated, see # {Knockapi::Models::Message} for more details. # @@ -152,28 +152,20 @@ class Message < Knockapi::Internal::Type::BaseModel # # @param _typename [String] The typename of the schema. # - # @param channel_id [String] The ID for the channel the message was sent through. - # - # @param engagement_statuses [Array] A list of engagement statuses. - # - # @param inserted_at [Time] Timestamp when the resource was created. - # - # @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer - # - # @param source [Knockapi::Models::Message::Source] The workflow that triggered the message. - # - # @param status [Symbol, Knockapi::Models::Message::Status] The message delivery status. - # - # @param updated_at [Time] The timestamp when the resource was last updated. - # # @param actors [Array] One or more actors that are associated with this message. Note: this is a list t # # @param archived_at [Time, nil] Timestamp when the message was archived. # + # @param channel_id [String] The ID for the channel the message was sent through. + # # @param clicked_at [Time, nil] Timestamp when the message was clicked. # # @param data [Hash{Symbol=>Object}, nil] Data associated with the message’s workflow run. Includes the workflow trigger r # + # @param engagement_statuses [Array] A list of engagement statuses. + # + # @param inserted_at [Time] Timestamp when the resource was created. + # # @param interacted_at [Time, nil] Timestamp when the message was interacted with. # # @param link_clicked_at [Time, nil] Timestamp when a link in the message was clicked. @@ -182,12 +174,20 @@ class Message < Knockapi::Internal::Type::BaseModel # # @param read_at [Time, nil] Timestamp when the message was read. # + # @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer + # # @param scheduled_at [Time, nil] Timestamp when the message was scheduled to be sent. # # @param seen_at [Time, nil] Timestamp when the message was seen. # + # @param source [Knockapi::Models::Message::Source] The workflow that triggered the message. + # + # @param status [Symbol, Knockapi::Models::Message::Status] The message delivery status. + # # @param tenant [String, nil] The ID of the `tenant` associated with the message. Only present when a `tenant` # + # @param updated_at [Time] The timestamp when the resource was last updated. + # # @param workflow [String, nil] The key of the workflow that generated the message. # An engagement status for a message. Can be one of: read, seen, interacted, @@ -231,7 +231,7 @@ class Source < Knockapi::Internal::Type::BaseModel required :version_id, String # @!attribute step_ref - # The step reference for the step in the workflow that generated the message. + # The step reference for the step in the workflow that generated the message # # @return [String, nil] optional :step_ref, String, nil?: true @@ -247,7 +247,7 @@ class Source < Knockapi::Internal::Type::BaseModel # # @param version_id [String] The ID of the version of the workflow that triggered the message. # - # @param step_ref [String, nil] The step reference for the step in the workflow that generated the message. + # @param step_ref [String, nil] The step reference for the step in the workflow that generated the message end # The message delivery status. diff --git a/rbi/knockapi/models/message.rbi b/rbi/knockapi/models/message.rbi index 9f41e9b4..bc6a7145 100644 --- a/rbi/knockapi/models/message.rbi +++ b/rbi/knockapi/models/message.rbi @@ -7,46 +7,18 @@ module Knockapi T.type_alias { T.any(Knockapi::Message, Knockapi::Internal::AnyHash) } # The unique identifier for the message. - sig { returns(String) } - attr_accessor :id - - # The typename of the schema. - sig { returns(String) } - attr_accessor :_typename - - # The ID for the channel the message was sent through. - sig { returns(String) } - attr_accessor :channel_id - - # A list of engagement statuses. - sig do - returns(T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol]) - end - attr_accessor :engagement_statuses - - # Timestamp when the resource was created. - sig { returns(Time) } - attr_accessor :inserted_at - - # A reference to a recipient, either a user identifier (string) or an object - # reference (ID, collection). - sig { returns(Knockapi::RecipientReference::Variants) } - attr_accessor :recipient - - # The workflow that triggered the message. - sig { returns(Knockapi::Message::Source) } - attr_reader :source + sig { returns(T.nilable(String)) } + attr_reader :id - sig { params(source: Knockapi::Message::Source::OrHash).void } - attr_writer :source + sig { params(id: String).void } + attr_writer :id - # The message delivery status. - sig { returns(Knockapi::Message::Status::TaggedSymbol) } - attr_accessor :status + # The typename of the schema. + sig { returns(T.nilable(String)) } + attr_reader :_typename - # The timestamp when the resource was last updated. - sig { returns(Time) } - attr_accessor :updated_at + sig { params(_typename: String).void } + attr_writer :_typename # One or more actors that are associated with this message. Note: this is a list # that can contain up to 10 actors if the message is produced from a @@ -73,6 +45,13 @@ module Knockapi sig { returns(T.nilable(Time)) } attr_accessor :archived_at + # The ID for the channel the message was sent through. + sig { returns(T.nilable(String)) } + attr_reader :channel_id + + sig { params(channel_id: String).void } + attr_writer :channel_id + # Timestamp when the message was clicked. sig { returns(T.nilable(Time)) } attr_accessor :clicked_at @@ -85,6 +64,29 @@ module Knockapi sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_accessor :data + # A list of engagement statuses. + sig do + returns( + T.nilable(T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol]) + ) + end + attr_reader :engagement_statuses + + sig do + params( + engagement_statuses: + T::Array[Knockapi::Message::EngagementStatus::OrSymbol] + ).void + end + attr_writer :engagement_statuses + + # Timestamp when the resource was created. + sig { returns(T.nilable(Time)) } + attr_reader :inserted_at + + sig { params(inserted_at: Time).void } + attr_writer :inserted_at + # Timestamp when the message was interacted with. sig { returns(T.nilable(Time)) } attr_accessor :interacted_at @@ -101,6 +103,19 @@ module Knockapi sig { returns(T.nilable(Time)) } attr_accessor :read_at + # A reference to a recipient, either a user identifier (string) or an object + # reference (ID, collection). + sig { returns(T.nilable(Knockapi::RecipientReference::Variants)) } + attr_reader :recipient + + sig do + params( + recipient: + T.any(String, Knockapi::RecipientReference::ObjectReference::OrHash) + ).void + end + attr_writer :recipient + # Timestamp when the message was scheduled to be sent. sig { returns(T.nilable(Time)) } attr_accessor :scheduled_at @@ -109,11 +124,32 @@ module Knockapi sig { returns(T.nilable(Time)) } attr_accessor :seen_at + # The workflow that triggered the message. + sig { returns(T.nilable(Knockapi::Message::Source)) } + attr_reader :source + + sig { params(source: Knockapi::Message::Source::OrHash).void } + attr_writer :source + + # The message delivery status. + sig { returns(T.nilable(Knockapi::Message::Status::TaggedSymbol)) } + attr_reader :status + + sig { params(status: Knockapi::Message::Status::OrSymbol).void } + attr_writer :status + # The ID of the `tenant` associated with the message. Only present when a `tenant` # is provided on a workflow trigger request. sig { returns(T.nilable(String)) } attr_accessor :tenant + # The timestamp when the resource was last updated. + sig { returns(T.nilable(Time)) } + attr_reader :updated_at + + sig { params(updated_at: Time).void } + attr_writer :updated_at + # The key of the workflow that generated the message. sig { returns(T.nilable(String)) } attr_accessor :workflow @@ -124,18 +160,6 @@ module Knockapi params( id: String, _typename: String, - channel_id: String, - engagement_statuses: - T::Array[Knockapi::Message::EngagementStatus::OrSymbol], - inserted_at: Time, - recipient: - T.any( - String, - Knockapi::RecipientReference::ObjectReference::OrHash - ), - source: Knockapi::Message::Source::OrHash, - status: Knockapi::Message::Status::OrSymbol, - updated_at: Time, actors: T::Array[ T.any( @@ -144,44 +168,43 @@ module Knockapi ) ], archived_at: T.nilable(Time), + channel_id: String, clicked_at: T.nilable(Time), data: T.nilable(T::Hash[Symbol, T.anything]), + engagement_statuses: + T::Array[Knockapi::Message::EngagementStatus::OrSymbol], + inserted_at: Time, interacted_at: T.nilable(Time), link_clicked_at: T.nilable(Time), metadata: T.nilable(T::Hash[Symbol, T.anything]), read_at: T.nilable(Time), + recipient: + T.any( + String, + Knockapi::RecipientReference::ObjectReference::OrHash + ), scheduled_at: T.nilable(Time), seen_at: T.nilable(Time), + source: Knockapi::Message::Source::OrHash, + status: Knockapi::Message::Status::OrSymbol, tenant: T.nilable(String), + updated_at: Time, workflow: T.nilable(String) ).returns(T.attached_class) end def self.new( # The unique identifier for the message. - id:, + id: nil, # The typename of the schema. - _typename:, - # The ID for the channel the message was sent through. - channel_id:, - # A list of engagement statuses. - engagement_statuses:, - # Timestamp when the resource was created. - inserted_at:, - # A reference to a recipient, either a user identifier (string) or an object - # reference (ID, collection). - recipient:, - # The workflow that triggered the message. - source:, - # The message delivery status. - status:, - # The timestamp when the resource was last updated. - updated_at:, + _typename: nil, # One or more actors that are associated with this message. Note: this is a list # that can contain up to 10 actors if the message is produced from a # [batch](/designing-workflows/batch-function). actors: nil, # Timestamp when the message was archived. archived_at: nil, + # The ID for the channel the message was sent through. + channel_id: nil, # Timestamp when the message was clicked. clicked_at: nil, # Data associated with the message’s workflow run. Includes the workflow trigger @@ -190,6 +213,10 @@ module Knockapi # after a [batch step](/designing-workflows/batch-function), includes the payload # `data` from the most-recent trigger request (the final `activity` in the batch). data: nil, + # A list of engagement statuses. + engagement_statuses: nil, + # Timestamp when the resource was created. + inserted_at: nil, # Timestamp when the message was interacted with. interacted_at: nil, # Timestamp when a link in the message was clicked. @@ -198,13 +225,22 @@ module Knockapi metadata: nil, # Timestamp when the message was read. read_at: nil, + # A reference to a recipient, either a user identifier (string) or an object + # reference (ID, collection). + recipient: nil, # Timestamp when the message was scheduled to be sent. scheduled_at: nil, # Timestamp when the message was seen. seen_at: nil, + # The workflow that triggered the message. + source: nil, + # The message delivery status. + status: nil, # The ID of the `tenant` associated with the message. Only present when a `tenant` # is provided on a workflow trigger request. tenant: nil, + # The timestamp when the resource was last updated. + updated_at: nil, # The key of the workflow that generated the message. workflow: nil ) @@ -215,25 +251,25 @@ module Knockapi { id: String, _typename: String, - channel_id: String, - engagement_statuses: - T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol], - inserted_at: Time, - recipient: Knockapi::RecipientReference::Variants, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status::TaggedSymbol, - updated_at: Time, actors: T::Array[Knockapi::RecipientReference::Variants], archived_at: T.nilable(Time), + channel_id: String, clicked_at: T.nilable(Time), data: T.nilable(T::Hash[Symbol, T.anything]), + engagement_statuses: + T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol], + inserted_at: Time, interacted_at: T.nilable(Time), link_clicked_at: T.nilable(Time), metadata: T.nilable(T::Hash[Symbol, T.anything]), read_at: T.nilable(Time), + recipient: Knockapi::RecipientReference::Variants, scheduled_at: T.nilable(Time), seen_at: T.nilable(Time), + source: Knockapi::Message::Source, + status: Knockapi::Message::Status::TaggedSymbol, tenant: T.nilable(String), + updated_at: Time, workflow: T.nilable(String) } ) @@ -292,7 +328,7 @@ module Knockapi sig { returns(String) } attr_accessor :version_id - # The step reference for the step in the workflow that generated the message. + # The step reference for the step in the workflow that generated the message sig { returns(T.nilable(String)) } attr_accessor :step_ref @@ -314,7 +350,7 @@ module Knockapi key:, # The ID of the version of the workflow that triggered the message. version_id:, - # The step reference for the step in the workflow that generated the message. + # The step reference for the step in the workflow that generated the message step_ref: nil ) end diff --git a/sig/knockapi/models/message.rbs b/sig/knockapi/models/message.rbs index 77b10fbe..72f3ac44 100644 --- a/sig/knockapi/models/message.rbs +++ b/sig/knockapi/models/message.rbs @@ -4,45 +4,35 @@ module Knockapi { id: String, _typename: String, - channel_id: String, - engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], - inserted_at: Time, - recipient: Knockapi::Models::recipient_reference, - source: Knockapi::Message::Source, - status: Knockapi::Models::Message::status, - updated_at: Time, actors: ::Array[Knockapi::Models::recipient_reference], archived_at: Time?, + channel_id: String, clicked_at: Time?, data: ::Hash[Symbol, top]?, + engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], + inserted_at: Time, interacted_at: Time?, link_clicked_at: Time?, metadata: ::Hash[Symbol, top]?, read_at: Time?, + recipient: Knockapi::Models::recipient_reference, scheduled_at: Time?, seen_at: Time?, + source: Knockapi::Message::Source, + status: Knockapi::Models::Message::status, tenant: String?, + updated_at: Time, workflow: String? } class Message < Knockapi::Internal::Type::BaseModel - attr_accessor id: String + attr_reader id: String? - attr_accessor _typename: String + def id=: (String) -> String - attr_accessor channel_id: String + attr_reader _typename: String? - attr_accessor engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status] - - attr_accessor inserted_at: Time - - attr_accessor recipient: Knockapi::Models::recipient_reference - - attr_accessor source: Knockapi::Message::Source - - attr_accessor status: Knockapi::Models::Message::status - - attr_accessor updated_at: Time + def _typename=: (String) -> String attr_reader actors: ::Array[Knockapi::Models::recipient_reference]? @@ -52,10 +42,24 @@ module Knockapi attr_accessor archived_at: Time? + attr_reader channel_id: String? + + def channel_id=: (String) -> String + attr_accessor clicked_at: Time? attr_accessor data: ::Hash[Symbol, top]? + attr_reader engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status]? + + def engagement_statuses=: ( + ::Array[Knockapi::Models::Message::engagement_status] + ) -> ::Array[Knockapi::Models::Message::engagement_status] + + attr_reader inserted_at: Time? + + def inserted_at=: (Time) -> Time + attr_accessor interacted_at: Time? attr_accessor link_clicked_at: Time? @@ -64,59 +68,79 @@ module Knockapi attr_accessor read_at: Time? + attr_reader recipient: Knockapi::Models::recipient_reference? + + def recipient=: ( + Knockapi::Models::recipient_reference + ) -> Knockapi::Models::recipient_reference + attr_accessor scheduled_at: Time? attr_accessor seen_at: Time? + attr_reader source: Knockapi::Message::Source? + + def source=: (Knockapi::Message::Source) -> Knockapi::Message::Source + + attr_reader status: Knockapi::Models::Message::status? + + def status=: ( + Knockapi::Models::Message::status + ) -> Knockapi::Models::Message::status + attr_accessor tenant: String? + attr_reader updated_at: Time? + + def updated_at=: (Time) -> Time + attr_accessor workflow: String? def initialize: ( - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], - inserted_at: Time, - recipient: Knockapi::Models::recipient_reference, - source: Knockapi::Message::Source, - status: Knockapi::Models::Message::status, - updated_at: Time, + ?id: String, + ?_typename: String, ?actors: ::Array[Knockapi::Models::recipient_reference], ?archived_at: Time?, + ?channel_id: String, ?clicked_at: Time?, ?data: ::Hash[Symbol, top]?, + ?engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], + ?inserted_at: Time, ?interacted_at: Time?, ?link_clicked_at: Time?, ?metadata: ::Hash[Symbol, top]?, ?read_at: Time?, + ?recipient: Knockapi::Models::recipient_reference, ?scheduled_at: Time?, ?seen_at: Time?, + ?source: Knockapi::Message::Source, + ?status: Knockapi::Models::Message::status, ?tenant: String?, + ?updated_at: Time, ?workflow: String? ) -> void def to_hash: -> { id: String, _typename: String, - channel_id: String, - engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], - inserted_at: Time, - recipient: Knockapi::Models::recipient_reference, - source: Knockapi::Message::Source, - status: Knockapi::Models::Message::status, - updated_at: Time, actors: ::Array[Knockapi::Models::recipient_reference], archived_at: Time?, + channel_id: String, clicked_at: Time?, data: ::Hash[Symbol, top]?, + engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], + inserted_at: Time, interacted_at: Time?, link_clicked_at: Time?, metadata: ::Hash[Symbol, top]?, read_at: Time?, + recipient: Knockapi::Models::recipient_reference, scheduled_at: Time?, seen_at: Time?, + source: Knockapi::Message::Source, + status: Knockapi::Models::Message::status, tenant: String?, + updated_at: Time, workflow: String? } diff --git a/test/knockapi/resources/messages_test.rb b/test/knockapi/resources/messages_test.rb index 908b280d..093d4a6d 100644 --- a/test/knockapi/resources/messages_test.rb +++ b/test/knockapi/resources/messages_test.rb @@ -21,26 +21,26 @@ def test_list assert_pattern do row => { - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), - inserted_at: Time, - recipient: Knockapi::RecipientReference, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status, - updated_at: Time, + id: String | nil, + _typename: String | nil, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, + channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, + inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, + recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, + source: Knockapi::Message::Source | nil, + status: Knockapi::Message::Status | nil, tenant: String | nil, + updated_at: Time | nil, workflow: String | nil } end @@ -57,26 +57,26 @@ def test_archive assert_pattern do response => { - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), - inserted_at: Time, - recipient: Knockapi::RecipientReference, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status, - updated_at: Time, + id: String | nil, + _typename: String | nil, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, + channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, + inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, + recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, + source: Knockapi::Message::Source | nil, + status: Knockapi::Message::Status | nil, tenant: String | nil, + updated_at: Time | nil, workflow: String | nil } end @@ -93,26 +93,26 @@ def test_get assert_pattern do response => { - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), - inserted_at: Time, - recipient: Knockapi::RecipientReference, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status, - updated_at: Time, + id: String | nil, + _typename: String | nil, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, + channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, + inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, + recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, + source: Knockapi::Message::Source | nil, + status: Knockapi::Message::Status | nil, tenant: String | nil, + updated_at: Time | nil, workflow: String | nil } end @@ -234,26 +234,26 @@ def test_mark_as_interacted assert_pattern do response => { - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), - inserted_at: Time, - recipient: Knockapi::RecipientReference, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status, - updated_at: Time, + id: String | nil, + _typename: String | nil, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, + channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, + inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, + recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, + source: Knockapi::Message::Source | nil, + status: Knockapi::Message::Status | nil, tenant: String | nil, + updated_at: Time | nil, workflow: String | nil } end @@ -270,26 +270,26 @@ def test_mark_as_read assert_pattern do response => { - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), - inserted_at: Time, - recipient: Knockapi::RecipientReference, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status, - updated_at: Time, + id: String | nil, + _typename: String | nil, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, + channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, + inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, + recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, + source: Knockapi::Message::Source | nil, + status: Knockapi::Message::Status | nil, tenant: String | nil, + updated_at: Time | nil, workflow: String | nil } end @@ -306,26 +306,26 @@ def test_mark_as_seen assert_pattern do response => { - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), - inserted_at: Time, - recipient: Knockapi::RecipientReference, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status, - updated_at: Time, + id: String | nil, + _typename: String | nil, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, + channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, + inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, + recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, + source: Knockapi::Message::Source | nil, + status: Knockapi::Message::Status | nil, tenant: String | nil, + updated_at: Time | nil, workflow: String | nil } end @@ -342,26 +342,26 @@ def test_mark_as_unread assert_pattern do response => { - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), - inserted_at: Time, - recipient: Knockapi::RecipientReference, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status, - updated_at: Time, + id: String | nil, + _typename: String | nil, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, + channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, + inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, + recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, + source: Knockapi::Message::Source | nil, + status: Knockapi::Message::Status | nil, tenant: String | nil, + updated_at: Time | nil, workflow: String | nil } end @@ -378,26 +378,26 @@ def test_mark_as_unseen assert_pattern do response => { - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), - inserted_at: Time, - recipient: Knockapi::RecipientReference, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status, - updated_at: Time, + id: String | nil, + _typename: String | nil, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, + channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, + inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, + recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, + source: Knockapi::Message::Source | nil, + status: Knockapi::Message::Status | nil, tenant: String | nil, + updated_at: Time | nil, workflow: String | nil } end @@ -414,26 +414,26 @@ def test_unarchive assert_pattern do response => { - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), - inserted_at: Time, - recipient: Knockapi::RecipientReference, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status, - updated_at: Time, + id: String | nil, + _typename: String | nil, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, + channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, + inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, + recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, + source: Knockapi::Message::Source | nil, + status: Knockapi::Message::Status | nil, tenant: String | nil, + updated_at: Time | nil, workflow: String | nil } end diff --git a/test/knockapi/resources/objects_test.rb b/test/knockapi/resources/objects_test.rb index 77fb40cb..4b70b3e9 100644 --- a/test/knockapi/resources/objects_test.rb +++ b/test/knockapi/resources/objects_test.rb @@ -139,26 +139,26 @@ def test_list_messages assert_pattern do row => { - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), - inserted_at: Time, - recipient: Knockapi::RecipientReference, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status, - updated_at: Time, + id: String | nil, + _typename: String | nil, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, + channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, + inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, + recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, + source: Knockapi::Message::Source | nil, + status: Knockapi::Message::Status | nil, tenant: String | nil, + updated_at: Time | nil, workflow: String | nil } end diff --git a/test/knockapi/resources/users_test.rb b/test/knockapi/resources/users_test.rb index 9e96c24e..2f0d1e07 100644 --- a/test/knockapi/resources/users_test.rb +++ b/test/knockapi/resources/users_test.rb @@ -148,26 +148,26 @@ def test_list_messages assert_pattern do row => { - id: String, - _typename: String, - channel_id: String, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), - inserted_at: Time, - recipient: Knockapi::RecipientReference, - source: Knockapi::Message::Source, - status: Knockapi::Message::Status, - updated_at: Time, + id: String | nil, + _typename: String | nil, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, + channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, + inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, + recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, + source: Knockapi::Message::Source | nil, + status: Knockapi::Message::Status | nil, tenant: String | nil, + updated_at: Time | nil, workflow: String | nil } end From 243593653acf3381827206d7c3844350fb395fce Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 3 Sep 2025 18:29:41 +0000 Subject: [PATCH 2/6] feat(api): api update --- .stats.yml | 4 +- lib/knockapi/models/identify_user_request.rb | 4 +- .../models/inline_identify_user_request.rb | 4 +- lib/knockapi/models/inline_object_request.rb | 4 +- lib/knockapi/models/message.rb | 130 ++++++------ lib/knockapi/models/object_set_params.rb | 4 +- .../models/objects/bulk_set_params.rb | 4 +- .../models/recipients/channel_data.rb | 28 ++- .../models/recipients/channel_data_request.rb | 27 ++- .../recipients/inline_channel_data_request.rb | 23 ++- lib/knockapi/models/tenant_request.rb | 4 +- lib/knockapi/models/tenant_set_params.rb | 4 +- lib/knockapi/resources/objects.rb | 4 +- lib/knockapi/resources/tenants.rb | 2 +- lib/knockapi/resources/users.rb | 4 +- rbi/knockapi/models/identify_user_request.rbi | 3 + .../models/inline_identify_user_request.rbi | 3 + rbi/knockapi/models/inline_object_request.rbi | 3 + rbi/knockapi/models/message.rbi | 188 +++++++----------- rbi/knockapi/models/object_set_params.rbi | 4 + .../models/objects/bulk_set_params.rbi | 3 + .../models/recipients/channel_data.rbi | 41 +++- .../recipients/channel_data_request.rbi | 34 ++++ .../inline_channel_data_request.rbi | 31 +++ rbi/knockapi/models/tenant_request.rbi | 3 + rbi/knockapi/models/tenant_set_params.rbi | 3 + rbi/knockapi/resources/objects.rbi | 2 + rbi/knockapi/resources/tenants.rbi | 1 + rbi/knockapi/resources/users.rbi | 2 + sig/knockapi/models/message.rbs | 98 ++++----- .../models/recipients/channel_data.rbs | 13 ++ .../recipients/channel_data_request.rbs | 11 + .../inline_channel_data_request.rbs | 11 + test/knockapi/resources/messages_test.rb | 162 +++++++-------- test/knockapi/resources/objects_test.rb | 18 +- test/knockapi/resources/users_test.rb | 18 +- 36 files changed, 535 insertions(+), 367 deletions(-) diff --git a/.stats.yml b/.stats.yml index 232dd9da..bfde4684 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 89 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-e4ea1ded040ebfa923df0d24ef37ae3c742383828cda85e1489bc2cb5e14da29.yml -openapi_spec_hash: 4cfd1f5f0d42e1b821f70ba12089b606 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-2d3aac5f3ddf05db97231694fc7fab3f0f2abac4691944dd52bf5a250a4edaa5.yml +openapi_spec_hash: 6418b750ca4a74b7248e3913fefb0bed config_hash: 5c872aa99cad9b9602e84668f5b38a8a diff --git a/lib/knockapi/models/identify_user_request.rb b/lib/knockapi/models/identify_user_request.rb index 8a449a15..37b2256b 100644 --- a/lib/knockapi/models/identify_user_request.rb +++ b/lib/knockapi/models/identify_user_request.rb @@ -12,7 +12,7 @@ class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -79,7 +79,7 @@ class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel # # @param avatar [String, nil] A URL for the avatar of the user. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] The creation date of the user from your system. # diff --git a/lib/knockapi/models/inline_identify_user_request.rb b/lib/knockapi/models/inline_identify_user_request.rb index 98aa2fea..28f3e395 100644 --- a/lib/knockapi/models/inline_identify_user_request.rb +++ b/lib/knockapi/models/inline_identify_user_request.rb @@ -18,7 +18,7 @@ class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -88,7 +88,7 @@ class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel # # @param avatar [String, nil] A URL for the avatar of the user. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] The creation date of the user from your system. # diff --git a/lib/knockapi/models/inline_object_request.rb b/lib/knockapi/models/inline_object_request.rb index 6cab007b..45c0881a 100644 --- a/lib/knockapi/models/inline_object_request.rb +++ b/lib/knockapi/models/inline_object_request.rb @@ -18,7 +18,7 @@ class InlineObjectRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -51,7 +51,7 @@ class InlineObjectRequest < Knockapi::Internal::Type::BaseModel # # @param collection [String] The collection this object belongs to. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] Timestamp when the resource was created. # diff --git a/lib/knockapi/models/message.rb b/lib/knockapi/models/message.rb index 7c567650..251af541 100644 --- a/lib/knockapi/models/message.rb +++ b/lib/knockapi/models/message.rb @@ -7,14 +7,58 @@ class Message < Knockapi::Internal::Type::BaseModel # @!attribute id # The unique identifier for the message. # - # @return [String, nil] - optional :id, String + # @return [String] + required :id, String # @!attribute _typename # The typename of the schema. # - # @return [String, nil] - optional :_typename, String, api_name: :__typename + # @return [String] + required :_typename, String, api_name: :__typename + + # @!attribute channel_id + # The ID for the channel the message was sent through. + # + # @return [String] + required :channel_id, String + + # @!attribute engagement_statuses + # A list of engagement statuses. + # + # @return [Array] + required :engagement_statuses, + -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus] } + + # @!attribute inserted_at + # Timestamp when the resource was created. + # + # @return [Time] + required :inserted_at, Time + + # @!attribute recipient + # A reference to a recipient, either a user identifier (string) or an object + # reference (ID, collection). + # + # @return [String, Knockapi::Models::RecipientReference::ObjectReference] + required :recipient, union: -> { Knockapi::RecipientReference } + + # @!attribute source + # The workflow that triggered the message. + # + # @return [Knockapi::Models::Message::Source] + required :source, -> { Knockapi::Message::Source } + + # @!attribute status + # The message delivery status. + # + # @return [Symbol, Knockapi::Models::Message::Status] + required :status, enum: -> { Knockapi::Message::Status } + + # @!attribute updated_at + # The timestamp when the resource was last updated. + # + # @return [Time] + required :updated_at, Time # @!attribute actors # One or more actors that are associated with this message. Note: this is a list @@ -30,12 +74,6 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [Time, nil] optional :archived_at, Time, nil?: true - # @!attribute channel_id - # The ID for the channel the message was sent through. - # - # @return [String, nil] - optional :channel_id, String - # @!attribute clicked_at # Timestamp when the message was clicked. # @@ -52,19 +90,6 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [Hash{Symbol=>Object}, nil] optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true - # @!attribute engagement_statuses - # A list of engagement statuses. - # - # @return [Array, nil] - optional :engagement_statuses, - -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus] } - - # @!attribute inserted_at - # Timestamp when the resource was created. - # - # @return [Time, nil] - optional :inserted_at, Time - # @!attribute interacted_at # Timestamp when the message was interacted with. # @@ -89,13 +114,6 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [Time, nil] optional :read_at, Time, nil?: true - # @!attribute recipient - # A reference to a recipient, either a user identifier (string) or an object - # reference (ID, collection). - # - # @return [String, Knockapi::Models::RecipientReference::ObjectReference, nil] - optional :recipient, union: -> { Knockapi::RecipientReference } - # @!attribute scheduled_at # Timestamp when the message was scheduled to be sent. # @@ -108,18 +126,6 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [Time, nil] optional :seen_at, Time, nil?: true - # @!attribute source - # The workflow that triggered the message. - # - # @return [Knockapi::Models::Message::Source, nil] - optional :source, -> { Knockapi::Message::Source } - - # @!attribute status - # The message delivery status. - # - # @return [Symbol, Knockapi::Models::Message::Status, nil] - optional :status, enum: -> { Knockapi::Message::Status } - # @!attribute tenant # The ID of the `tenant` associated with the message. Only present when a `tenant` # is provided on a workflow trigger request. @@ -127,12 +133,6 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [String, nil] optional :tenant, String, nil?: true - # @!attribute updated_at - # The timestamp when the resource was last updated. - # - # @return [Time, nil] - optional :updated_at, Time - # @!attribute workflow # @deprecated # @@ -141,7 +141,7 @@ class Message < Knockapi::Internal::Type::BaseModel # @return [String, nil] optional :workflow, String, nil?: true - # @!method initialize(id: nil, _typename: nil, actors: nil, archived_at: nil, channel_id: nil, clicked_at: nil, data: nil, engagement_statuses: nil, inserted_at: nil, interacted_at: nil, link_clicked_at: nil, metadata: nil, read_at: nil, recipient: nil, scheduled_at: nil, seen_at: nil, source: nil, status: nil, tenant: nil, updated_at: nil, workflow: nil) + # @!method initialize(id:, _typename:, channel_id:, engagement_statuses:, inserted_at:, recipient:, source:, status:, updated_at:, actors: nil, archived_at: nil, clicked_at: nil, data: nil, interacted_at: nil, link_clicked_at: nil, metadata: nil, read_at: nil, scheduled_at: nil, seen_at: nil, tenant: nil, workflow: nil) # Some parameter documentations has been truncated, see # {Knockapi::Models::Message} for more details. # @@ -152,20 +152,28 @@ class Message < Knockapi::Internal::Type::BaseModel # # @param _typename [String] The typename of the schema. # + # @param channel_id [String] The ID for the channel the message was sent through. + # + # @param engagement_statuses [Array] A list of engagement statuses. + # + # @param inserted_at [Time] Timestamp when the resource was created. + # + # @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer + # + # @param source [Knockapi::Models::Message::Source] The workflow that triggered the message. + # + # @param status [Symbol, Knockapi::Models::Message::Status] The message delivery status. + # + # @param updated_at [Time] The timestamp when the resource was last updated. + # # @param actors [Array] One or more actors that are associated with this message. Note: this is a list t # # @param archived_at [Time, nil] Timestamp when the message was archived. # - # @param channel_id [String] The ID for the channel the message was sent through. - # # @param clicked_at [Time, nil] Timestamp when the message was clicked. # # @param data [Hash{Symbol=>Object}, nil] Data associated with the message’s workflow run. Includes the workflow trigger r # - # @param engagement_statuses [Array] A list of engagement statuses. - # - # @param inserted_at [Time] Timestamp when the resource was created. - # # @param interacted_at [Time, nil] Timestamp when the message was interacted with. # # @param link_clicked_at [Time, nil] Timestamp when a link in the message was clicked. @@ -174,20 +182,12 @@ class Message < Knockapi::Internal::Type::BaseModel # # @param read_at [Time, nil] Timestamp when the message was read. # - # @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer - # # @param scheduled_at [Time, nil] Timestamp when the message was scheduled to be sent. # # @param seen_at [Time, nil] Timestamp when the message was seen. # - # @param source [Knockapi::Models::Message::Source] The workflow that triggered the message. - # - # @param status [Symbol, Knockapi::Models::Message::Status] The message delivery status. - # # @param tenant [String, nil] The ID of the `tenant` associated with the message. Only present when a `tenant` # - # @param updated_at [Time] The timestamp when the resource was last updated. - # # @param workflow [String, nil] The key of the workflow that generated the message. # An engagement status for a message. Can be one of: read, seen, interacted, @@ -231,7 +231,7 @@ class Source < Knockapi::Internal::Type::BaseModel required :version_id, String # @!attribute step_ref - # The step reference for the step in the workflow that generated the message + # The step reference for the step in the workflow that generated the message. # # @return [String, nil] optional :step_ref, String, nil?: true @@ -247,7 +247,7 @@ class Source < Knockapi::Internal::Type::BaseModel # # @param version_id [String] The ID of the version of the workflow that triggered the message. # - # @param step_ref [String, nil] The step reference for the step in the workflow that generated the message + # @param step_ref [String, nil] The step reference for the step in the workflow that generated the message. end # The message delivery status. diff --git a/lib/knockapi/models/object_set_params.rb b/lib/knockapi/models/object_set_params.rb index e84f52ca..757245b1 100644 --- a/lib/knockapi/models/object_set_params.rb +++ b/lib/knockapi/models/object_set_params.rb @@ -10,7 +10,7 @@ class ObjectSetParams < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] } @@ -42,7 +42,7 @@ class ObjectSetParams < Knockapi::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Knockapi::Models::ObjectSetParams} for more details. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. # # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations # diff --git a/lib/knockapi/models/objects/bulk_set_params.rb b/lib/knockapi/models/objects/bulk_set_params.rb index 18f89ca7..9b8ce706 100644 --- a/lib/knockapi/models/objects/bulk_set_params.rb +++ b/lib/knockapi/models/objects/bulk_set_params.rb @@ -29,7 +29,7 @@ class Object < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -60,7 +60,7 @@ class Object < Knockapi::Internal::Type::BaseModel # # @param id [String] Unique identifier for the object. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] Timestamp when the resource was created. # diff --git a/lib/knockapi/models/recipients/channel_data.rb b/lib/knockapi/models/recipients/channel_data.rb index 90268ad7..87ea2a7d 100644 --- a/lib/knockapi/models/recipients/channel_data.rb +++ b/lib/knockapi/models/recipients/channel_data.rb @@ -19,7 +19,7 @@ class RecipientsChannelData < Knockapi::Internal::Type::BaseModel # @!attribute data # Channel data for a given channel type. # - # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData] + # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData] required :data, union: -> { Knockapi::Recipients::RecipientsChannelData::Data } # @!attribute provider @@ -35,7 +35,7 @@ class RecipientsChannelData < Knockapi::Internal::Type::BaseModel # # @param channel_id [String] The unique identifier for the channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData] Channel data for a given channel type. # # @param provider [Symbol, Knockapi::Models::Recipients::RecipientsChannelData::Provider] The type of provider. @@ -60,8 +60,29 @@ module Data # OneSignal channel data. variant -> { Knockapi::Recipients::OneSignalChannelData } + # AWS SNS push channel data. + variant -> { Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData } + + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + # @!attribute target_arns + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + # + # @return [Array] + required :target_arns, Knockapi::Internal::Type::ArrayOf[String] + + # @!method initialize(target_arns:) + # Some parameter documentations has been truncated, see + # {Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData} + # for more details. + # + # AWS SNS push channel data. + # + # @param target_arns [Array] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin + end + # @!method self.variants - # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData)] + # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData)] end # The type of provider. @@ -72,6 +93,7 @@ module Provider PUSH_FCM = :push_fcm PUSH_APNS = :push_apns + PUSH_AWS_SNS = :push_aws_sns PUSH_EXPO = :push_expo PUSH_ONE_SIGNAL = :push_one_signal CHAT_SLACK = :chat_slack diff --git a/lib/knockapi/models/recipients/channel_data_request.rb b/lib/knockapi/models/recipients/channel_data_request.rb index e1dfd93d..a6a25824 100644 --- a/lib/knockapi/models/recipients/channel_data_request.rb +++ b/lib/knockapi/models/recipients/channel_data_request.rb @@ -7,13 +7,13 @@ class ChannelDataRequest < Knockapi::Internal::Type::BaseModel # @!attribute data # Channel data for a given channel type. # - # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] + # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] required :data, union: -> { Knockapi::Recipients::ChannelDataRequest::Data } # @!method initialize(data:) # A request to set channel data for a type of channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. # Channel data for a given channel type. # @@ -27,6 +27,9 @@ module Data # OneSignal channel data. variant -> { Knockapi::Recipients::OneSignalChannelData } + # AWS SNS push channel data. + variant -> { Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData } + # Slack channel data. variant -> { Knockapi::Recipients::SlackChannelData } @@ -36,8 +39,26 @@ module Data # Discord channel data. variant -> { Knockapi::Recipients::DiscordChannelData } + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + # @!attribute target_arns + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + # + # @return [Array] + required :target_arns, Knockapi::Internal::Type::ArrayOf[String] + + # @!method initialize(target_arns:) + # Some parameter documentations has been truncated, see + # {Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData} + # for more details. + # + # AWS SNS push channel data. + # + # @param target_arns [Array] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin + end + # @!method self.variants - # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] + # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] end end end diff --git a/lib/knockapi/models/recipients/inline_channel_data_request.rb b/lib/knockapi/models/recipients/inline_channel_data_request.rb index 613f9d3a..6bc83b31 100644 --- a/lib/knockapi/models/recipients/inline_channel_data_request.rb +++ b/lib/knockapi/models/recipients/inline_channel_data_request.rb @@ -13,6 +13,9 @@ module InlineChannelDataRequestItem # OneSignal channel data. variant -> { Knockapi::Recipients::OneSignalChannelData } + # AWS SNS push channel data. + variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData } + # Slack channel data. variant -> { Knockapi::Recipients::SlackChannelData } @@ -22,8 +25,26 @@ module InlineChannelDataRequestItem # Discord channel data. variant -> { Knockapi::Recipients::DiscordChannelData } + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + # @!attribute target_arns + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + # + # @return [Array] + required :target_arns, Knockapi::Internal::Type::ArrayOf[String] + + # @!method initialize(target_arns:) + # Some parameter documentations has been truncated, see + # {Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData} + # for more details. + # + # AWS SNS push channel data. + # + # @param target_arns [Array] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin + end + # @!method self.variants - # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] + # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] end # @type [Knockapi::Internal::Type::Converter] diff --git a/lib/knockapi/models/tenant_request.rb b/lib/knockapi/models/tenant_request.rb index d4784dc7..8a4f64d8 100644 --- a/lib/knockapi/models/tenant_request.rb +++ b/lib/knockapi/models/tenant_request.rb @@ -12,7 +12,7 @@ class TenantRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -44,7 +44,7 @@ class TenantRequest < Knockapi::Internal::Type::BaseModel # # @param id [String] The unique identifier for the tenant. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id. # diff --git a/lib/knockapi/models/tenant_set_params.rb b/lib/knockapi/models/tenant_set_params.rb index 8716050f..4e88ca89 100644 --- a/lib/knockapi/models/tenant_set_params.rb +++ b/lib/knockapi/models/tenant_set_params.rb @@ -10,7 +10,7 @@ class TenantSetParams < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -24,7 +24,7 @@ class TenantSetParams < Knockapi::Internal::Type::BaseModel optional :settings, -> { Knockapi::TenantSetParams::Settings } # @!method initialize(channel_data: nil, settings: nil, request_options: {}) - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set. # diff --git a/lib/knockapi/resources/objects.rb b/lib/knockapi/resources/objects.rb index ba90ef31..1f299ef4 100644 --- a/lib/knockapi/resources/objects.rb +++ b/lib/knockapi/resources/objects.rb @@ -368,7 +368,7 @@ def list_subscriptions(collection, object_id_, params = {}) # # @param id [String] Unique identifier for the object. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. # # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations # @@ -404,7 +404,7 @@ def set(collection, id, params = {}) # # @param channel_id [String] The unique identifier for the channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. # # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/knockapi/resources/tenants.rb b/lib/knockapi/resources/tenants.rb index c8ad3e25..63cbd9be 100644 --- a/lib/knockapi/resources/tenants.rb +++ b/lib/knockapi/resources/tenants.rb @@ -84,7 +84,7 @@ def get(id, params = {}) # # @param id [String] The unique identifier for the tenant. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set. # diff --git a/lib/knockapi/resources/users.rb b/lib/knockapi/resources/users.rb index 297ef65b..491e5a48 100644 --- a/lib/knockapi/resources/users.rb +++ b/lib/knockapi/resources/users.rb @@ -25,7 +25,7 @@ class Users # # @param avatar [String, nil] A URL for the avatar of the user. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] The creation date of the user from your system. # @@ -354,7 +354,7 @@ def merge(user_id, params) # # @param channel_id [String] The unique identifier for the channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. # # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/rbi/knockapi/models/identify_user_request.rbi b/rbi/knockapi/models/identify_user_request.rbi index c5a6bfd7..f19d7e9b 100644 --- a/rbi/knockapi/models/identify_user_request.rbi +++ b/rbi/knockapi/models/identify_user_request.rbi @@ -21,6 +21,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -82,6 +83,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -142,6 +144,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/inline_identify_user_request.rbi b/rbi/knockapi/models/inline_identify_user_request.rbi index 4a4c08be..feb3ccc9 100644 --- a/rbi/knockapi/models/inline_identify_user_request.rbi +++ b/rbi/knockapi/models/inline_identify_user_request.rbi @@ -28,6 +28,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -91,6 +92,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -154,6 +156,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/inline_object_request.rbi b/rbi/knockapi/models/inline_object_request.rbi index fe863c55..ea440d3e 100644 --- a/rbi/knockapi/models/inline_object_request.rbi +++ b/rbi/knockapi/models/inline_object_request.rbi @@ -25,6 +25,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -61,6 +62,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -105,6 +107,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/message.rbi b/rbi/knockapi/models/message.rbi index bc6a7145..9f41e9b4 100644 --- a/rbi/knockapi/models/message.rbi +++ b/rbi/knockapi/models/message.rbi @@ -7,18 +7,46 @@ module Knockapi T.type_alias { T.any(Knockapi::Message, Knockapi::Internal::AnyHash) } # The unique identifier for the message. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id + sig { returns(String) } + attr_accessor :id # The typename of the schema. - sig { returns(T.nilable(String)) } - attr_reader :_typename + sig { returns(String) } + attr_accessor :_typename + + # The ID for the channel the message was sent through. + sig { returns(String) } + attr_accessor :channel_id + + # A list of engagement statuses. + sig do + returns(T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol]) + end + attr_accessor :engagement_statuses + + # Timestamp when the resource was created. + sig { returns(Time) } + attr_accessor :inserted_at + + # A reference to a recipient, either a user identifier (string) or an object + # reference (ID, collection). + sig { returns(Knockapi::RecipientReference::Variants) } + attr_accessor :recipient + + # The workflow that triggered the message. + sig { returns(Knockapi::Message::Source) } + attr_reader :source + + sig { params(source: Knockapi::Message::Source::OrHash).void } + attr_writer :source + + # The message delivery status. + sig { returns(Knockapi::Message::Status::TaggedSymbol) } + attr_accessor :status - sig { params(_typename: String).void } - attr_writer :_typename + # The timestamp when the resource was last updated. + sig { returns(Time) } + attr_accessor :updated_at # One or more actors that are associated with this message. Note: this is a list # that can contain up to 10 actors if the message is produced from a @@ -45,13 +73,6 @@ module Knockapi sig { returns(T.nilable(Time)) } attr_accessor :archived_at - # The ID for the channel the message was sent through. - sig { returns(T.nilable(String)) } - attr_reader :channel_id - - sig { params(channel_id: String).void } - attr_writer :channel_id - # Timestamp when the message was clicked. sig { returns(T.nilable(Time)) } attr_accessor :clicked_at @@ -64,29 +85,6 @@ module Knockapi sig { returns(T.nilable(T::Hash[Symbol, T.anything])) } attr_accessor :data - # A list of engagement statuses. - sig do - returns( - T.nilable(T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol]) - ) - end - attr_reader :engagement_statuses - - sig do - params( - engagement_statuses: - T::Array[Knockapi::Message::EngagementStatus::OrSymbol] - ).void - end - attr_writer :engagement_statuses - - # Timestamp when the resource was created. - sig { returns(T.nilable(Time)) } - attr_reader :inserted_at - - sig { params(inserted_at: Time).void } - attr_writer :inserted_at - # Timestamp when the message was interacted with. sig { returns(T.nilable(Time)) } attr_accessor :interacted_at @@ -103,19 +101,6 @@ module Knockapi sig { returns(T.nilable(Time)) } attr_accessor :read_at - # A reference to a recipient, either a user identifier (string) or an object - # reference (ID, collection). - sig { returns(T.nilable(Knockapi::RecipientReference::Variants)) } - attr_reader :recipient - - sig do - params( - recipient: - T.any(String, Knockapi::RecipientReference::ObjectReference::OrHash) - ).void - end - attr_writer :recipient - # Timestamp when the message was scheduled to be sent. sig { returns(T.nilable(Time)) } attr_accessor :scheduled_at @@ -124,32 +109,11 @@ module Knockapi sig { returns(T.nilable(Time)) } attr_accessor :seen_at - # The workflow that triggered the message. - sig { returns(T.nilable(Knockapi::Message::Source)) } - attr_reader :source - - sig { params(source: Knockapi::Message::Source::OrHash).void } - attr_writer :source - - # The message delivery status. - sig { returns(T.nilable(Knockapi::Message::Status::TaggedSymbol)) } - attr_reader :status - - sig { params(status: Knockapi::Message::Status::OrSymbol).void } - attr_writer :status - # The ID of the `tenant` associated with the message. Only present when a `tenant` # is provided on a workflow trigger request. sig { returns(T.nilable(String)) } attr_accessor :tenant - # The timestamp when the resource was last updated. - sig { returns(T.nilable(Time)) } - attr_reader :updated_at - - sig { params(updated_at: Time).void } - attr_writer :updated_at - # The key of the workflow that generated the message. sig { returns(T.nilable(String)) } attr_accessor :workflow @@ -160,6 +124,18 @@ module Knockapi params( id: String, _typename: String, + channel_id: String, + engagement_statuses: + T::Array[Knockapi::Message::EngagementStatus::OrSymbol], + inserted_at: Time, + recipient: + T.any( + String, + Knockapi::RecipientReference::ObjectReference::OrHash + ), + source: Knockapi::Message::Source::OrHash, + status: Knockapi::Message::Status::OrSymbol, + updated_at: Time, actors: T::Array[ T.any( @@ -168,43 +144,44 @@ module Knockapi ) ], archived_at: T.nilable(Time), - channel_id: String, clicked_at: T.nilable(Time), data: T.nilable(T::Hash[Symbol, T.anything]), - engagement_statuses: - T::Array[Knockapi::Message::EngagementStatus::OrSymbol], - inserted_at: Time, interacted_at: T.nilable(Time), link_clicked_at: T.nilable(Time), metadata: T.nilable(T::Hash[Symbol, T.anything]), read_at: T.nilable(Time), - recipient: - T.any( - String, - Knockapi::RecipientReference::ObjectReference::OrHash - ), scheduled_at: T.nilable(Time), seen_at: T.nilable(Time), - source: Knockapi::Message::Source::OrHash, - status: Knockapi::Message::Status::OrSymbol, tenant: T.nilable(String), - updated_at: Time, workflow: T.nilable(String) ).returns(T.attached_class) end def self.new( # The unique identifier for the message. - id: nil, + id:, # The typename of the schema. - _typename: nil, + _typename:, + # The ID for the channel the message was sent through. + channel_id:, + # A list of engagement statuses. + engagement_statuses:, + # Timestamp when the resource was created. + inserted_at:, + # A reference to a recipient, either a user identifier (string) or an object + # reference (ID, collection). + recipient:, + # The workflow that triggered the message. + source:, + # The message delivery status. + status:, + # The timestamp when the resource was last updated. + updated_at:, # One or more actors that are associated with this message. Note: this is a list # that can contain up to 10 actors if the message is produced from a # [batch](/designing-workflows/batch-function). actors: nil, # Timestamp when the message was archived. archived_at: nil, - # The ID for the channel the message was sent through. - channel_id: nil, # Timestamp when the message was clicked. clicked_at: nil, # Data associated with the message’s workflow run. Includes the workflow trigger @@ -213,10 +190,6 @@ module Knockapi # after a [batch step](/designing-workflows/batch-function), includes the payload # `data` from the most-recent trigger request (the final `activity` in the batch). data: nil, - # A list of engagement statuses. - engagement_statuses: nil, - # Timestamp when the resource was created. - inserted_at: nil, # Timestamp when the message was interacted with. interacted_at: nil, # Timestamp when a link in the message was clicked. @@ -225,22 +198,13 @@ module Knockapi metadata: nil, # Timestamp when the message was read. read_at: nil, - # A reference to a recipient, either a user identifier (string) or an object - # reference (ID, collection). - recipient: nil, # Timestamp when the message was scheduled to be sent. scheduled_at: nil, # Timestamp when the message was seen. seen_at: nil, - # The workflow that triggered the message. - source: nil, - # The message delivery status. - status: nil, # The ID of the `tenant` associated with the message. Only present when a `tenant` # is provided on a workflow trigger request. tenant: nil, - # The timestamp when the resource was last updated. - updated_at: nil, # The key of the workflow that generated the message. workflow: nil ) @@ -251,25 +215,25 @@ module Knockapi { id: String, _typename: String, - actors: T::Array[Knockapi::RecipientReference::Variants], - archived_at: T.nilable(Time), channel_id: String, - clicked_at: T.nilable(Time), - data: T.nilable(T::Hash[Symbol, T.anything]), engagement_statuses: T::Array[Knockapi::Message::EngagementStatus::TaggedSymbol], inserted_at: Time, + recipient: Knockapi::RecipientReference::Variants, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status::TaggedSymbol, + updated_at: Time, + actors: T::Array[Knockapi::RecipientReference::Variants], + archived_at: T.nilable(Time), + clicked_at: T.nilable(Time), + data: T.nilable(T::Hash[Symbol, T.anything]), interacted_at: T.nilable(Time), link_clicked_at: T.nilable(Time), metadata: T.nilable(T::Hash[Symbol, T.anything]), read_at: T.nilable(Time), - recipient: Knockapi::RecipientReference::Variants, scheduled_at: T.nilable(Time), seen_at: T.nilable(Time), - source: Knockapi::Message::Source, - status: Knockapi::Message::Status::TaggedSymbol, tenant: T.nilable(String), - updated_at: Time, workflow: T.nilable(String) } ) @@ -328,7 +292,7 @@ module Knockapi sig { returns(String) } attr_accessor :version_id - # The step reference for the step in the workflow that generated the message + # The step reference for the step in the workflow that generated the message. sig { returns(T.nilable(String)) } attr_accessor :step_ref @@ -350,7 +314,7 @@ module Knockapi key:, # The ID of the version of the workflow that triggered the message. version_id:, - # The step reference for the step in the workflow that generated the message + # The step reference for the step in the workflow that generated the message. step_ref: nil ) end diff --git a/rbi/knockapi/models/object_set_params.rbi b/rbi/knockapi/models/object_set_params.rbi index d8832020..7b3c3214 100644 --- a/rbi/knockapi/models/object_set_params.rbi +++ b/rbi/knockapi/models/object_set_params.rbi @@ -20,6 +20,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -38,6 +39,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -85,6 +87,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -125,6 +128,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/objects/bulk_set_params.rbi b/rbi/knockapi/models/objects/bulk_set_params.rbi index e4fffb00..6269dac5 100644 --- a/rbi/knockapi/models/objects/bulk_set_params.rbi +++ b/rbi/knockapi/models/objects/bulk_set_params.rbi @@ -62,6 +62,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -99,6 +100,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -140,6 +142,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/recipients/channel_data.rbi b/rbi/knockapi/models/recipients/channel_data.rbi index d0459603..b61d8294 100644 --- a/rbi/knockapi/models/recipients/channel_data.rbi +++ b/rbi/knockapi/models/recipients/channel_data.rbi @@ -55,7 +55,8 @@ module Knockapi Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash, - Knockapi::Recipients::OneSignalChannelData::OrHash + Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData::OrHash ), provider: Knockapi::Recipients::RecipientsChannelData::Provider::OrSymbol @@ -98,10 +99,41 @@ module Knockapi Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData, - Knockapi::Recipients::OneSignalChannelData + Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData ) end + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData, + Knockapi::Internal::AnyHash + ) + end + + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + sig { returns(T::Array[String]) } + attr_accessor :target_arns + + # AWS SNS push channel data. + sig do + params(target_arns: T::Array[String]).returns(T.attached_class) + end + def self.new( + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + target_arns: + ) + end + + sig { override.returns({ target_arns: T::Array[String] }) } + def to_hash + end + end + sig do override.returns( T::Array[ @@ -136,6 +168,11 @@ module Knockapi :push_apns, Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol ) + PUSH_AWS_SNS = + T.let( + :push_aws_sns, + Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol + ) PUSH_EXPO = T.let( :push_expo, diff --git a/rbi/knockapi/models/recipients/channel_data_request.rbi b/rbi/knockapi/models/recipients/channel_data_request.rbi index df815dcb..1c9429e6 100644 --- a/rbi/knockapi/models/recipients/channel_data_request.rbi +++ b/rbi/knockapi/models/recipients/channel_data_request.rbi @@ -18,6 +18,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -33,6 +34,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -52,6 +54,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -71,12 +74,43 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData ) end + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, + Knockapi::Internal::AnyHash + ) + end + + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + sig { returns(T::Array[String]) } + attr_accessor :target_arns + + # AWS SNS push channel data. + sig do + params(target_arns: T::Array[String]).returns(T.attached_class) + end + def self.new( + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + target_arns: + ) + end + + sig { override.returns({ target_arns: T::Array[String] }) } + def to_hash + end + end + sig do override.returns( T::Array[Knockapi::Recipients::ChannelDataRequest::Data::Variants] diff --git a/rbi/knockapi/models/recipients/inline_channel_data_request.rbi b/rbi/knockapi/models/recipients/inline_channel_data_request.rbi index 8dc0189c..67ea4a1a 100644 --- a/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +++ b/rbi/knockapi/models/recipients/inline_channel_data_request.rbi @@ -12,12 +12,43 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData ) end + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, + Knockapi::Internal::AnyHash + ) + end + + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + sig { returns(T::Array[String]) } + attr_accessor :target_arns + + # AWS SNS push channel data. + sig do + params(target_arns: T::Array[String]).returns(T.attached_class) + end + def self.new( + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + target_arns: + ) + end + + sig { override.returns({ target_arns: T::Array[String] }) } + def to_hash + end + end + sig do override.returns( T::Array[ diff --git a/rbi/knockapi/models/tenant_request.rbi b/rbi/knockapi/models/tenant_request.rbi index 16c39e00..afe4b43b 100644 --- a/rbi/knockapi/models/tenant_request.rbi +++ b/rbi/knockapi/models/tenant_request.rbi @@ -21,6 +21,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -60,6 +61,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -101,6 +103,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/tenant_set_params.rbi b/rbi/knockapi/models/tenant_set_params.rbi index 6f4e8e76..e0e34075 100644 --- a/rbi/knockapi/models/tenant_set_params.rbi +++ b/rbi/knockapi/models/tenant_set_params.rbi @@ -20,6 +20,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -46,6 +47,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -75,6 +77,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/resources/objects.rbi b/rbi/knockapi/resources/objects.rbi index cfbeaa53..ae419c16 100644 --- a/rbi/knockapi/resources/objects.rbi +++ b/rbi/knockapi/resources/objects.rbi @@ -355,6 +355,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -402,6 +403,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash diff --git a/rbi/knockapi/resources/tenants.rbi b/rbi/knockapi/resources/tenants.rbi index 6ba629ab..f327b61e 100644 --- a/rbi/knockapi/resources/tenants.rbi +++ b/rbi/knockapi/resources/tenants.rbi @@ -72,6 +72,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash diff --git a/rbi/knockapi/resources/users.rbi b/rbi/knockapi/resources/users.rbi index dc33b6a3..754ba5e6 100644 --- a/rbi/knockapi/resources/users.rbi +++ b/rbi/knockapi/resources/users.rbi @@ -26,6 +26,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -344,6 +345,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash diff --git a/sig/knockapi/models/message.rbs b/sig/knockapi/models/message.rbs index 72f3ac44..77b10fbe 100644 --- a/sig/knockapi/models/message.rbs +++ b/sig/knockapi/models/message.rbs @@ -4,35 +4,45 @@ module Knockapi { id: String, _typename: String, + channel_id: String, + engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], + inserted_at: Time, + recipient: Knockapi::Models::recipient_reference, + source: Knockapi::Message::Source, + status: Knockapi::Models::Message::status, + updated_at: Time, actors: ::Array[Knockapi::Models::recipient_reference], archived_at: Time?, - channel_id: String, clicked_at: Time?, data: ::Hash[Symbol, top]?, - engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], - inserted_at: Time, interacted_at: Time?, link_clicked_at: Time?, metadata: ::Hash[Symbol, top]?, read_at: Time?, - recipient: Knockapi::Models::recipient_reference, scheduled_at: Time?, seen_at: Time?, - source: Knockapi::Message::Source, - status: Knockapi::Models::Message::status, tenant: String?, - updated_at: Time, workflow: String? } class Message < Knockapi::Internal::Type::BaseModel - attr_reader id: String? + attr_accessor id: String - def id=: (String) -> String + attr_accessor _typename: String - attr_reader _typename: String? + attr_accessor channel_id: String - def _typename=: (String) -> String + attr_accessor engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status] + + attr_accessor inserted_at: Time + + attr_accessor recipient: Knockapi::Models::recipient_reference + + attr_accessor source: Knockapi::Message::Source + + attr_accessor status: Knockapi::Models::Message::status + + attr_accessor updated_at: Time attr_reader actors: ::Array[Knockapi::Models::recipient_reference]? @@ -42,24 +52,10 @@ module Knockapi attr_accessor archived_at: Time? - attr_reader channel_id: String? - - def channel_id=: (String) -> String - attr_accessor clicked_at: Time? attr_accessor data: ::Hash[Symbol, top]? - attr_reader engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status]? - - def engagement_statuses=: ( - ::Array[Knockapi::Models::Message::engagement_status] - ) -> ::Array[Knockapi::Models::Message::engagement_status] - - attr_reader inserted_at: Time? - - def inserted_at=: (Time) -> Time - attr_accessor interacted_at: Time? attr_accessor link_clicked_at: Time? @@ -68,79 +64,59 @@ module Knockapi attr_accessor read_at: Time? - attr_reader recipient: Knockapi::Models::recipient_reference? - - def recipient=: ( - Knockapi::Models::recipient_reference - ) -> Knockapi::Models::recipient_reference - attr_accessor scheduled_at: Time? attr_accessor seen_at: Time? - attr_reader source: Knockapi::Message::Source? - - def source=: (Knockapi::Message::Source) -> Knockapi::Message::Source - - attr_reader status: Knockapi::Models::Message::status? - - def status=: ( - Knockapi::Models::Message::status - ) -> Knockapi::Models::Message::status - attr_accessor tenant: String? - attr_reader updated_at: Time? - - def updated_at=: (Time) -> Time - attr_accessor workflow: String? def initialize: ( - ?id: String, - ?_typename: String, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], + inserted_at: Time, + recipient: Knockapi::Models::recipient_reference, + source: Knockapi::Message::Source, + status: Knockapi::Models::Message::status, + updated_at: Time, ?actors: ::Array[Knockapi::Models::recipient_reference], ?archived_at: Time?, - ?channel_id: String, ?clicked_at: Time?, ?data: ::Hash[Symbol, top]?, - ?engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], - ?inserted_at: Time, ?interacted_at: Time?, ?link_clicked_at: Time?, ?metadata: ::Hash[Symbol, top]?, ?read_at: Time?, - ?recipient: Knockapi::Models::recipient_reference, ?scheduled_at: Time?, ?seen_at: Time?, - ?source: Knockapi::Message::Source, - ?status: Knockapi::Models::Message::status, ?tenant: String?, - ?updated_at: Time, ?workflow: String? ) -> void def to_hash: -> { id: String, _typename: String, + channel_id: String, + engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], + inserted_at: Time, + recipient: Knockapi::Models::recipient_reference, + source: Knockapi::Message::Source, + status: Knockapi::Models::Message::status, + updated_at: Time, actors: ::Array[Knockapi::Models::recipient_reference], archived_at: Time?, - channel_id: String, clicked_at: Time?, data: ::Hash[Symbol, top]?, - engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status], - inserted_at: Time, interacted_at: Time?, link_clicked_at: Time?, metadata: ::Hash[Symbol, top]?, read_at: Time?, - recipient: Knockapi::Models::recipient_reference, scheduled_at: Time?, seen_at: Time?, - source: Knockapi::Message::Source, - status: Knockapi::Models::Message::status, tenant: String?, - updated_at: Time, workflow: String? } diff --git a/sig/knockapi/models/recipients/channel_data.rbs b/sig/knockapi/models/recipients/channel_data.rbs index aa9e2087..a2f6e67f 100644 --- a/sig/knockapi/models/recipients/channel_data.rbs +++ b/sig/knockapi/models/recipients/channel_data.rbs @@ -42,16 +42,28 @@ module Knockapi | Knockapi::Recipients::MsTeamsChannelData | Knockapi::Recipients::DiscordChannelData | Knockapi::Recipients::OneSignalChannelData + | Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData module Data extend Knockapi::Internal::Type::Union + type aws_sns_push_channel_data = { target_arns: ::Array[String] } + + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + attr_accessor target_arns: ::Array[String] + + def initialize: (target_arns: ::Array[String]) -> void + + def to_hash: -> { target_arns: ::Array[String] } + end + def self?.variants: -> ::Array[Knockapi::Models::Recipients::RecipientsChannelData::data] end type provider = :push_fcm | :push_apns + | :push_aws_sns | :push_expo | :push_one_signal | :chat_slack @@ -64,6 +76,7 @@ module Knockapi PUSH_FCM: :push_fcm PUSH_APNS: :push_apns + PUSH_AWS_SNS: :push_aws_sns PUSH_EXPO: :push_expo PUSH_ONE_SIGNAL: :push_one_signal CHAT_SLACK: :chat_slack diff --git a/sig/knockapi/models/recipients/channel_data_request.rbs b/sig/knockapi/models/recipients/channel_data_request.rbs index 4020802e..6b97bcea 100644 --- a/sig/knockapi/models/recipients/channel_data_request.rbs +++ b/sig/knockapi/models/recipients/channel_data_request.rbs @@ -18,6 +18,7 @@ module Knockapi type data = Knockapi::Recipients::PushChannelData | Knockapi::Recipients::OneSignalChannelData + | Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData | Knockapi::Recipients::SlackChannelData | Knockapi::Recipients::MsTeamsChannelData | Knockapi::Recipients::DiscordChannelData @@ -25,6 +26,16 @@ module Knockapi module Data extend Knockapi::Internal::Type::Union + type aws_sns_push_channel_data = { target_arns: ::Array[String] } + + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + attr_accessor target_arns: ::Array[String] + + def initialize: (target_arns: ::Array[String]) -> void + + def to_hash: -> { target_arns: ::Array[String] } + end + def self?.variants: -> ::Array[Knockapi::Models::Recipients::ChannelDataRequest::data] end end diff --git a/sig/knockapi/models/recipients/inline_channel_data_request.rbs b/sig/knockapi/models/recipients/inline_channel_data_request.rbs index 29a17aec..a09a18c4 100644 --- a/sig/knockapi/models/recipients/inline_channel_data_request.rbs +++ b/sig/knockapi/models/recipients/inline_channel_data_request.rbs @@ -4,6 +4,7 @@ module Knockapi type inline_channel_data_request_item = Knockapi::Recipients::PushChannelData | Knockapi::Recipients::OneSignalChannelData + | Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData | Knockapi::Recipients::SlackChannelData | Knockapi::Recipients::MsTeamsChannelData | Knockapi::Recipients::DiscordChannelData @@ -11,6 +12,16 @@ module Knockapi module InlineChannelDataRequestItem extend Knockapi::Internal::Type::Union + type aws_sns_push_channel_data = { target_arns: ::Array[String] } + + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + attr_accessor target_arns: ::Array[String] + + def initialize: (target_arns: ::Array[String]) -> void + + def to_hash: -> { target_arns: ::Array[String] } + end + def self?.variants: -> ::Array[Knockapi::Models::Recipients::inline_channel_data_request_item] end diff --git a/test/knockapi/resources/messages_test.rb b/test/knockapi/resources/messages_test.rb index 093d4a6d..908b280d 100644 --- a/test/knockapi/resources/messages_test.rb +++ b/test/knockapi/resources/messages_test.rb @@ -21,26 +21,26 @@ def test_list assert_pattern do row => { - id: String | nil, - _typename: String | nil, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), + inserted_at: Time, + recipient: Knockapi::RecipientReference, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status, + updated_at: Time, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, - channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, - inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, - recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, - source: Knockapi::Message::Source | nil, - status: Knockapi::Message::Status | nil, tenant: String | nil, - updated_at: Time | nil, workflow: String | nil } end @@ -57,26 +57,26 @@ def test_archive assert_pattern do response => { - id: String | nil, - _typename: String | nil, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), + inserted_at: Time, + recipient: Knockapi::RecipientReference, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status, + updated_at: Time, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, - channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, - inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, - recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, - source: Knockapi::Message::Source | nil, - status: Knockapi::Message::Status | nil, tenant: String | nil, - updated_at: Time | nil, workflow: String | nil } end @@ -93,26 +93,26 @@ def test_get assert_pattern do response => { - id: String | nil, - _typename: String | nil, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), + inserted_at: Time, + recipient: Knockapi::RecipientReference, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status, + updated_at: Time, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, - channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, - inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, - recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, - source: Knockapi::Message::Source | nil, - status: Knockapi::Message::Status | nil, tenant: String | nil, - updated_at: Time | nil, workflow: String | nil } end @@ -234,26 +234,26 @@ def test_mark_as_interacted assert_pattern do response => { - id: String | nil, - _typename: String | nil, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), + inserted_at: Time, + recipient: Knockapi::RecipientReference, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status, + updated_at: Time, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, - channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, - inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, - recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, - source: Knockapi::Message::Source | nil, - status: Knockapi::Message::Status | nil, tenant: String | nil, - updated_at: Time | nil, workflow: String | nil } end @@ -270,26 +270,26 @@ def test_mark_as_read assert_pattern do response => { - id: String | nil, - _typename: String | nil, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), + inserted_at: Time, + recipient: Knockapi::RecipientReference, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status, + updated_at: Time, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, - channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, - inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, - recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, - source: Knockapi::Message::Source | nil, - status: Knockapi::Message::Status | nil, tenant: String | nil, - updated_at: Time | nil, workflow: String | nil } end @@ -306,26 +306,26 @@ def test_mark_as_seen assert_pattern do response => { - id: String | nil, - _typename: String | nil, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), + inserted_at: Time, + recipient: Knockapi::RecipientReference, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status, + updated_at: Time, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, - channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, - inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, - recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, - source: Knockapi::Message::Source | nil, - status: Knockapi::Message::Status | nil, tenant: String | nil, - updated_at: Time | nil, workflow: String | nil } end @@ -342,26 +342,26 @@ def test_mark_as_unread assert_pattern do response => { - id: String | nil, - _typename: String | nil, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), + inserted_at: Time, + recipient: Knockapi::RecipientReference, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status, + updated_at: Time, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, - channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, - inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, - recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, - source: Knockapi::Message::Source | nil, - status: Knockapi::Message::Status | nil, tenant: String | nil, - updated_at: Time | nil, workflow: String | nil } end @@ -378,26 +378,26 @@ def test_mark_as_unseen assert_pattern do response => { - id: String | nil, - _typename: String | nil, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), + inserted_at: Time, + recipient: Knockapi::RecipientReference, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status, + updated_at: Time, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, - channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, - inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, - recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, - source: Knockapi::Message::Source | nil, - status: Knockapi::Message::Status | nil, tenant: String | nil, - updated_at: Time | nil, workflow: String | nil } end @@ -414,26 +414,26 @@ def test_unarchive assert_pattern do response => { - id: String | nil, - _typename: String | nil, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), + inserted_at: Time, + recipient: Knockapi::RecipientReference, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status, + updated_at: Time, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, - channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, - inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, - recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, - source: Knockapi::Message::Source | nil, - status: Knockapi::Message::Status | nil, tenant: String | nil, - updated_at: Time | nil, workflow: String | nil } end diff --git a/test/knockapi/resources/objects_test.rb b/test/knockapi/resources/objects_test.rb index 4b70b3e9..77fb40cb 100644 --- a/test/knockapi/resources/objects_test.rb +++ b/test/knockapi/resources/objects_test.rb @@ -139,26 +139,26 @@ def test_list_messages assert_pattern do row => { - id: String | nil, - _typename: String | nil, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), + inserted_at: Time, + recipient: Knockapi::RecipientReference, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status, + updated_at: Time, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, - channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, - inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, - recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, - source: Knockapi::Message::Source | nil, - status: Knockapi::Message::Status | nil, tenant: String | nil, - updated_at: Time | nil, workflow: String | nil } end diff --git a/test/knockapi/resources/users_test.rb b/test/knockapi/resources/users_test.rb index 2f0d1e07..9e96c24e 100644 --- a/test/knockapi/resources/users_test.rb +++ b/test/knockapi/resources/users_test.rb @@ -148,26 +148,26 @@ def test_list_messages assert_pattern do row => { - id: String | nil, - _typename: String | nil, + id: String, + _typename: String, + channel_id: String, + engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]), + inserted_at: Time, + recipient: Knockapi::RecipientReference, + source: Knockapi::Message::Source, + status: Knockapi::Message::Status, + updated_at: Time, actors: ^(Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference]) | nil, archived_at: Time | nil, - channel_id: String | nil, clicked_at: Time | nil, data: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, - engagement_statuses: ^(Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus]) | nil, - inserted_at: Time | nil, interacted_at: Time | nil, link_clicked_at: Time | nil, metadata: ^(Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]) | nil, read_at: Time | nil, - recipient: Knockapi::RecipientReference | nil, scheduled_at: Time | nil, seen_at: Time | nil, - source: Knockapi::Message::Source | nil, - status: Knockapi::Message::Status | nil, tenant: String | nil, - updated_at: Time | nil, workflow: String | nil } end From 4cd0c7d4541e1da08e5489df81b4732ff995e8cb Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Thu, 4 Sep 2025 22:00:47 +0000 Subject: [PATCH 3/6] feat(api): api update --- .stats.yml | 4 +- lib/knockapi/models/identify_user_request.rb | 4 +- .../models/inline_identify_user_request.rb | 4 +- lib/knockapi/models/inline_object_request.rb | 4 +- lib/knockapi/models/object_set_params.rb | 4 +- .../models/objects/bulk_set_params.rb | 4 +- .../models/recipients/channel_data.rb | 28 ++----------- .../models/recipients/channel_data_request.rb | 27 ++---------- .../recipients/inline_channel_data_request.rb | 23 +---------- lib/knockapi/models/tenant_request.rb | 4 +- lib/knockapi/models/tenant_set_params.rb | 4 +- lib/knockapi/resources/objects.rb | 4 +- lib/knockapi/resources/tenants.rb | 2 +- lib/knockapi/resources/users.rb | 4 +- rbi/knockapi/models/identify_user_request.rbi | 3 -- .../models/inline_identify_user_request.rbi | 3 -- rbi/knockapi/models/inline_object_request.rbi | 3 -- rbi/knockapi/models/object_set_params.rbi | 4 -- .../models/objects/bulk_set_params.rbi | 3 -- .../models/recipients/channel_data.rbi | 41 +------------------ .../recipients/channel_data_request.rbi | 34 --------------- .../inline_channel_data_request.rbi | 31 -------------- rbi/knockapi/models/tenant_request.rbi | 3 -- rbi/knockapi/models/tenant_set_params.rbi | 3 -- rbi/knockapi/resources/objects.rbi | 2 - rbi/knockapi/resources/tenants.rbi | 1 - rbi/knockapi/resources/users.rbi | 2 - .../models/recipients/channel_data.rbs | 13 ------ .../recipients/channel_data_request.rbs | 11 ----- .../inline_channel_data_request.rbs | 11 ----- 30 files changed, 30 insertions(+), 258 deletions(-) diff --git a/.stats.yml b/.stats.yml index bfde4684..9cbdb2d3 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 89 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-2d3aac5f3ddf05db97231694fc7fab3f0f2abac4691944dd52bf5a250a4edaa5.yml -openapi_spec_hash: 6418b750ca4a74b7248e3913fefb0bed +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-8d6bb1a0b221b8b9fb9aae94419c46e2e1ca4732281924f24c6539c006d12cb8.yml +openapi_spec_hash: 5dd6c9f3cac4f8cc602c0d1543ec4de4 config_hash: 5c872aa99cad9b9602e84668f5b38a8a diff --git a/lib/knockapi/models/identify_user_request.rb b/lib/knockapi/models/identify_user_request.rb index 37b2256b..8a449a15 100644 --- a/lib/knockapi/models/identify_user_request.rb +++ b/lib/knockapi/models/identify_user_request.rb @@ -12,7 +12,7 @@ class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -79,7 +79,7 @@ class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel # # @param avatar [String, nil] A URL for the avatar of the user. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] The creation date of the user from your system. # diff --git a/lib/knockapi/models/inline_identify_user_request.rb b/lib/knockapi/models/inline_identify_user_request.rb index 28f3e395..98aa2fea 100644 --- a/lib/knockapi/models/inline_identify_user_request.rb +++ b/lib/knockapi/models/inline_identify_user_request.rb @@ -18,7 +18,7 @@ class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -88,7 +88,7 @@ class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel # # @param avatar [String, nil] A URL for the avatar of the user. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] The creation date of the user from your system. # diff --git a/lib/knockapi/models/inline_object_request.rb b/lib/knockapi/models/inline_object_request.rb index 45c0881a..6cab007b 100644 --- a/lib/knockapi/models/inline_object_request.rb +++ b/lib/knockapi/models/inline_object_request.rb @@ -18,7 +18,7 @@ class InlineObjectRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -51,7 +51,7 @@ class InlineObjectRequest < Knockapi::Internal::Type::BaseModel # # @param collection [String] The collection this object belongs to. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] Timestamp when the resource was created. # diff --git a/lib/knockapi/models/object_set_params.rb b/lib/knockapi/models/object_set_params.rb index 757245b1..e84f52ca 100644 --- a/lib/knockapi/models/object_set_params.rb +++ b/lib/knockapi/models/object_set_params.rb @@ -10,7 +10,7 @@ class ObjectSetParams < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] } @@ -42,7 +42,7 @@ class ObjectSetParams < Knockapi::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Knockapi::Models::ObjectSetParams} for more details. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. # # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations # diff --git a/lib/knockapi/models/objects/bulk_set_params.rb b/lib/knockapi/models/objects/bulk_set_params.rb index 9b8ce706..18f89ca7 100644 --- a/lib/knockapi/models/objects/bulk_set_params.rb +++ b/lib/knockapi/models/objects/bulk_set_params.rb @@ -29,7 +29,7 @@ class Object < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -60,7 +60,7 @@ class Object < Knockapi::Internal::Type::BaseModel # # @param id [String] Unique identifier for the object. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] Timestamp when the resource was created. # diff --git a/lib/knockapi/models/recipients/channel_data.rb b/lib/knockapi/models/recipients/channel_data.rb index 87ea2a7d..90268ad7 100644 --- a/lib/knockapi/models/recipients/channel_data.rb +++ b/lib/knockapi/models/recipients/channel_data.rb @@ -19,7 +19,7 @@ class RecipientsChannelData < Knockapi::Internal::Type::BaseModel # @!attribute data # Channel data for a given channel type. # - # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData] + # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData] required :data, union: -> { Knockapi::Recipients::RecipientsChannelData::Data } # @!attribute provider @@ -35,7 +35,7 @@ class RecipientsChannelData < Knockapi::Internal::Type::BaseModel # # @param channel_id [String] The unique identifier for the channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData] Channel data for a given channel type. # # @param provider [Symbol, Knockapi::Models::Recipients::RecipientsChannelData::Provider] The type of provider. @@ -60,29 +60,8 @@ module Data # OneSignal channel data. variant -> { Knockapi::Recipients::OneSignalChannelData } - # AWS SNS push channel data. - variant -> { Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData } - - class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel - # @!attribute target_arns - # A list of platform endpoint ARNs. See - # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). - # - # @return [Array] - required :target_arns, Knockapi::Internal::Type::ArrayOf[String] - - # @!method initialize(target_arns:) - # Some parameter documentations has been truncated, see - # {Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData} - # for more details. - # - # AWS SNS push channel data. - # - # @param target_arns [Array] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin - end - # @!method self.variants - # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData)] + # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData)] end # The type of provider. @@ -93,7 +72,6 @@ module Provider PUSH_FCM = :push_fcm PUSH_APNS = :push_apns - PUSH_AWS_SNS = :push_aws_sns PUSH_EXPO = :push_expo PUSH_ONE_SIGNAL = :push_one_signal CHAT_SLACK = :chat_slack diff --git a/lib/knockapi/models/recipients/channel_data_request.rb b/lib/knockapi/models/recipients/channel_data_request.rb index a6a25824..e1dfd93d 100644 --- a/lib/knockapi/models/recipients/channel_data_request.rb +++ b/lib/knockapi/models/recipients/channel_data_request.rb @@ -7,13 +7,13 @@ class ChannelDataRequest < Knockapi::Internal::Type::BaseModel # @!attribute data # Channel data for a given channel type. # - # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] + # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] required :data, union: -> { Knockapi::Recipients::ChannelDataRequest::Data } # @!method initialize(data:) # A request to set channel data for a type of channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. # Channel data for a given channel type. # @@ -27,9 +27,6 @@ module Data # OneSignal channel data. variant -> { Knockapi::Recipients::OneSignalChannelData } - # AWS SNS push channel data. - variant -> { Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData } - # Slack channel data. variant -> { Knockapi::Recipients::SlackChannelData } @@ -39,26 +36,8 @@ module Data # Discord channel data. variant -> { Knockapi::Recipients::DiscordChannelData } - class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel - # @!attribute target_arns - # A list of platform endpoint ARNs. See - # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). - # - # @return [Array] - required :target_arns, Knockapi::Internal::Type::ArrayOf[String] - - # @!method initialize(target_arns:) - # Some parameter documentations has been truncated, see - # {Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData} - # for more details. - # - # AWS SNS push channel data. - # - # @param target_arns [Array] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin - end - # @!method self.variants - # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] + # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] end end end diff --git a/lib/knockapi/models/recipients/inline_channel_data_request.rb b/lib/knockapi/models/recipients/inline_channel_data_request.rb index 6bc83b31..613f9d3a 100644 --- a/lib/knockapi/models/recipients/inline_channel_data_request.rb +++ b/lib/knockapi/models/recipients/inline_channel_data_request.rb @@ -13,9 +13,6 @@ module InlineChannelDataRequestItem # OneSignal channel data. variant -> { Knockapi::Recipients::OneSignalChannelData } - # AWS SNS push channel data. - variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData } - # Slack channel data. variant -> { Knockapi::Recipients::SlackChannelData } @@ -25,26 +22,8 @@ module InlineChannelDataRequestItem # Discord channel data. variant -> { Knockapi::Recipients::DiscordChannelData } - class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel - # @!attribute target_arns - # A list of platform endpoint ARNs. See - # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). - # - # @return [Array] - required :target_arns, Knockapi::Internal::Type::ArrayOf[String] - - # @!method initialize(target_arns:) - # Some parameter documentations has been truncated, see - # {Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData} - # for more details. - # - # AWS SNS push channel data. - # - # @param target_arns [Array] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin - end - # @!method self.variants - # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] + # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] end # @type [Knockapi::Internal::Type::Converter] diff --git a/lib/knockapi/models/tenant_request.rb b/lib/knockapi/models/tenant_request.rb index 8a4f64d8..d4784dc7 100644 --- a/lib/knockapi/models/tenant_request.rb +++ b/lib/knockapi/models/tenant_request.rb @@ -12,7 +12,7 @@ class TenantRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -44,7 +44,7 @@ class TenantRequest < Knockapi::Internal::Type::BaseModel # # @param id [String] The unique identifier for the tenant. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id. # diff --git a/lib/knockapi/models/tenant_set_params.rb b/lib/knockapi/models/tenant_set_params.rb index 4e88ca89..8716050f 100644 --- a/lib/knockapi/models/tenant_set_params.rb +++ b/lib/knockapi/models/tenant_set_params.rb @@ -10,7 +10,7 @@ class TenantSetParams < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -24,7 +24,7 @@ class TenantSetParams < Knockapi::Internal::Type::BaseModel optional :settings, -> { Knockapi::TenantSetParams::Settings } # @!method initialize(channel_data: nil, settings: nil, request_options: {}) - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set. # diff --git a/lib/knockapi/resources/objects.rb b/lib/knockapi/resources/objects.rb index 1f299ef4..ba90ef31 100644 --- a/lib/knockapi/resources/objects.rb +++ b/lib/knockapi/resources/objects.rb @@ -368,7 +368,7 @@ def list_subscriptions(collection, object_id_, params = {}) # # @param id [String] Unique identifier for the object. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. # # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations # @@ -404,7 +404,7 @@ def set(collection, id, params = {}) # # @param channel_id [String] The unique identifier for the channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. # # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/knockapi/resources/tenants.rb b/lib/knockapi/resources/tenants.rb index 63cbd9be..c8ad3e25 100644 --- a/lib/knockapi/resources/tenants.rb +++ b/lib/knockapi/resources/tenants.rb @@ -84,7 +84,7 @@ def get(id, params = {}) # # @param id [String] The unique identifier for the tenant. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set. # diff --git a/lib/knockapi/resources/users.rb b/lib/knockapi/resources/users.rb index 491e5a48..297ef65b 100644 --- a/lib/knockapi/resources/users.rb +++ b/lib/knockapi/resources/users.rb @@ -25,7 +25,7 @@ class Users # # @param avatar [String, nil] A URL for the avatar of the user. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] The creation date of the user from your system. # @@ -354,7 +354,7 @@ def merge(user_id, params) # # @param channel_id [String] The unique identifier for the channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. # # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/rbi/knockapi/models/identify_user_request.rbi b/rbi/knockapi/models/identify_user_request.rbi index f19d7e9b..c5a6bfd7 100644 --- a/rbi/knockapi/models/identify_user_request.rbi +++ b/rbi/knockapi/models/identify_user_request.rbi @@ -21,7 +21,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -83,7 +82,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -144,7 +142,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/inline_identify_user_request.rbi b/rbi/knockapi/models/inline_identify_user_request.rbi index feb3ccc9..4a4c08be 100644 --- a/rbi/knockapi/models/inline_identify_user_request.rbi +++ b/rbi/knockapi/models/inline_identify_user_request.rbi @@ -28,7 +28,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -92,7 +91,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -156,7 +154,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/inline_object_request.rbi b/rbi/knockapi/models/inline_object_request.rbi index ea440d3e..fe863c55 100644 --- a/rbi/knockapi/models/inline_object_request.rbi +++ b/rbi/knockapi/models/inline_object_request.rbi @@ -25,7 +25,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -62,7 +61,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -107,7 +105,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/object_set_params.rbi b/rbi/knockapi/models/object_set_params.rbi index 7b3c3214..d8832020 100644 --- a/rbi/knockapi/models/object_set_params.rbi +++ b/rbi/knockapi/models/object_set_params.rbi @@ -20,7 +20,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -39,7 +38,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -87,7 +85,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -128,7 +125,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/objects/bulk_set_params.rbi b/rbi/knockapi/models/objects/bulk_set_params.rbi index 6269dac5..e4fffb00 100644 --- a/rbi/knockapi/models/objects/bulk_set_params.rbi +++ b/rbi/knockapi/models/objects/bulk_set_params.rbi @@ -62,7 +62,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -100,7 +99,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -142,7 +140,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/recipients/channel_data.rbi b/rbi/knockapi/models/recipients/channel_data.rbi index b61d8294..d0459603 100644 --- a/rbi/knockapi/models/recipients/channel_data.rbi +++ b/rbi/knockapi/models/recipients/channel_data.rbi @@ -55,8 +55,7 @@ module Knockapi Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash, - Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData::OrHash + Knockapi::Recipients::OneSignalChannelData::OrHash ), provider: Knockapi::Recipients::RecipientsChannelData::Provider::OrSymbol @@ -99,41 +98,10 @@ module Knockapi Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData, - Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData + Knockapi::Recipients::OneSignalChannelData ) end - class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData, - Knockapi::Internal::AnyHash - ) - end - - # A list of platform endpoint ARNs. See - # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). - sig { returns(T::Array[String]) } - attr_accessor :target_arns - - # AWS SNS push channel data. - sig do - params(target_arns: T::Array[String]).returns(T.attached_class) - end - def self.new( - # A list of platform endpoint ARNs. See - # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). - target_arns: - ) - end - - sig { override.returns({ target_arns: T::Array[String] }) } - def to_hash - end - end - sig do override.returns( T::Array[ @@ -168,11 +136,6 @@ module Knockapi :push_apns, Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol ) - PUSH_AWS_SNS = - T.let( - :push_aws_sns, - Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol - ) PUSH_EXPO = T.let( :push_expo, diff --git a/rbi/knockapi/models/recipients/channel_data_request.rbi b/rbi/knockapi/models/recipients/channel_data_request.rbi index 1c9429e6..df815dcb 100644 --- a/rbi/knockapi/models/recipients/channel_data_request.rbi +++ b/rbi/knockapi/models/recipients/channel_data_request.rbi @@ -18,7 +18,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -34,7 +33,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -54,7 +52,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -74,43 +71,12 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData ) end - class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, - Knockapi::Internal::AnyHash - ) - end - - # A list of platform endpoint ARNs. See - # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). - sig { returns(T::Array[String]) } - attr_accessor :target_arns - - # AWS SNS push channel data. - sig do - params(target_arns: T::Array[String]).returns(T.attached_class) - end - def self.new( - # A list of platform endpoint ARNs. See - # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). - target_arns: - ) - end - - sig { override.returns({ target_arns: T::Array[String] }) } - def to_hash - end - end - sig do override.returns( T::Array[Knockapi::Recipients::ChannelDataRequest::Data::Variants] diff --git a/rbi/knockapi/models/recipients/inline_channel_data_request.rbi b/rbi/knockapi/models/recipients/inline_channel_data_request.rbi index 67ea4a1a..8dc0189c 100644 --- a/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +++ b/rbi/knockapi/models/recipients/inline_channel_data_request.rbi @@ -12,43 +12,12 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData ) end - class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, - Knockapi::Internal::AnyHash - ) - end - - # A list of platform endpoint ARNs. See - # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). - sig { returns(T::Array[String]) } - attr_accessor :target_arns - - # AWS SNS push channel data. - sig do - params(target_arns: T::Array[String]).returns(T.attached_class) - end - def self.new( - # A list of platform endpoint ARNs. See - # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). - target_arns: - ) - end - - sig { override.returns({ target_arns: T::Array[String] }) } - def to_hash - end - end - sig do override.returns( T::Array[ diff --git a/rbi/knockapi/models/tenant_request.rbi b/rbi/knockapi/models/tenant_request.rbi index afe4b43b..16c39e00 100644 --- a/rbi/knockapi/models/tenant_request.rbi +++ b/rbi/knockapi/models/tenant_request.rbi @@ -21,7 +21,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -61,7 +60,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -103,7 +101,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/tenant_set_params.rbi b/rbi/knockapi/models/tenant_set_params.rbi index e0e34075..6f4e8e76 100644 --- a/rbi/knockapi/models/tenant_set_params.rbi +++ b/rbi/knockapi/models/tenant_set_params.rbi @@ -20,7 +20,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -47,7 +46,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -77,7 +75,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/resources/objects.rbi b/rbi/knockapi/resources/objects.rbi index ae419c16..cfbeaa53 100644 --- a/rbi/knockapi/resources/objects.rbi +++ b/rbi/knockapi/resources/objects.rbi @@ -355,7 +355,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -403,7 +402,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash diff --git a/rbi/knockapi/resources/tenants.rbi b/rbi/knockapi/resources/tenants.rbi index f327b61e..6ba629ab 100644 --- a/rbi/knockapi/resources/tenants.rbi +++ b/rbi/knockapi/resources/tenants.rbi @@ -72,7 +72,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash diff --git a/rbi/knockapi/resources/users.rbi b/rbi/knockapi/resources/users.rbi index 754ba5e6..dc33b6a3 100644 --- a/rbi/knockapi/resources/users.rbi +++ b/rbi/knockapi/resources/users.rbi @@ -26,7 +26,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -345,7 +344,6 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, - Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash diff --git a/sig/knockapi/models/recipients/channel_data.rbs b/sig/knockapi/models/recipients/channel_data.rbs index a2f6e67f..aa9e2087 100644 --- a/sig/knockapi/models/recipients/channel_data.rbs +++ b/sig/knockapi/models/recipients/channel_data.rbs @@ -42,28 +42,16 @@ module Knockapi | Knockapi::Recipients::MsTeamsChannelData | Knockapi::Recipients::DiscordChannelData | Knockapi::Recipients::OneSignalChannelData - | Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData module Data extend Knockapi::Internal::Type::Union - type aws_sns_push_channel_data = { target_arns: ::Array[String] } - - class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel - attr_accessor target_arns: ::Array[String] - - def initialize: (target_arns: ::Array[String]) -> void - - def to_hash: -> { target_arns: ::Array[String] } - end - def self?.variants: -> ::Array[Knockapi::Models::Recipients::RecipientsChannelData::data] end type provider = :push_fcm | :push_apns - | :push_aws_sns | :push_expo | :push_one_signal | :chat_slack @@ -76,7 +64,6 @@ module Knockapi PUSH_FCM: :push_fcm PUSH_APNS: :push_apns - PUSH_AWS_SNS: :push_aws_sns PUSH_EXPO: :push_expo PUSH_ONE_SIGNAL: :push_one_signal CHAT_SLACK: :chat_slack diff --git a/sig/knockapi/models/recipients/channel_data_request.rbs b/sig/knockapi/models/recipients/channel_data_request.rbs index 6b97bcea..4020802e 100644 --- a/sig/knockapi/models/recipients/channel_data_request.rbs +++ b/sig/knockapi/models/recipients/channel_data_request.rbs @@ -18,7 +18,6 @@ module Knockapi type data = Knockapi::Recipients::PushChannelData | Knockapi::Recipients::OneSignalChannelData - | Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData | Knockapi::Recipients::SlackChannelData | Knockapi::Recipients::MsTeamsChannelData | Knockapi::Recipients::DiscordChannelData @@ -26,16 +25,6 @@ module Knockapi module Data extend Knockapi::Internal::Type::Union - type aws_sns_push_channel_data = { target_arns: ::Array[String] } - - class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel - attr_accessor target_arns: ::Array[String] - - def initialize: (target_arns: ::Array[String]) -> void - - def to_hash: -> { target_arns: ::Array[String] } - end - def self?.variants: -> ::Array[Knockapi::Models::Recipients::ChannelDataRequest::data] end end diff --git a/sig/knockapi/models/recipients/inline_channel_data_request.rbs b/sig/knockapi/models/recipients/inline_channel_data_request.rbs index a09a18c4..29a17aec 100644 --- a/sig/knockapi/models/recipients/inline_channel_data_request.rbs +++ b/sig/knockapi/models/recipients/inline_channel_data_request.rbs @@ -4,7 +4,6 @@ module Knockapi type inline_channel_data_request_item = Knockapi::Recipients::PushChannelData | Knockapi::Recipients::OneSignalChannelData - | Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData | Knockapi::Recipients::SlackChannelData | Knockapi::Recipients::MsTeamsChannelData | Knockapi::Recipients::DiscordChannelData @@ -12,16 +11,6 @@ module Knockapi module InlineChannelDataRequestItem extend Knockapi::Internal::Type::Union - type aws_sns_push_channel_data = { target_arns: ::Array[String] } - - class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel - attr_accessor target_arns: ::Array[String] - - def initialize: (target_arns: ::Array[String]) -> void - - def to_hash: -> { target_arns: ::Array[String] } - end - def self?.variants: -> ::Array[Knockapi::Models::Recipients::inline_channel_data_request_item] end From 4cbcd27c56bf486d159ceefc0890014184aab50d Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 5 Sep 2025 16:55:55 +0000 Subject: [PATCH 4/6] feat(api): api update --- .stats.yml | 4 +- lib/knockapi/models/identify_user_request.rb | 4 +- .../models/inline_identify_user_request.rb | 4 +- lib/knockapi/models/inline_object_request.rb | 4 +- lib/knockapi/models/object_set_params.rb | 4 +- .../models/objects/bulk_set_params.rb | 4 +- .../models/recipients/channel_data.rb | 28 +++++++++++-- .../models/recipients/channel_data_request.rb | 27 ++++++++++-- .../recipients/inline_channel_data_request.rb | 23 ++++++++++- lib/knockapi/models/tenant_request.rb | 4 +- lib/knockapi/models/tenant_set_params.rb | 4 +- lib/knockapi/resources/objects.rb | 4 +- lib/knockapi/resources/tenants.rb | 2 +- lib/knockapi/resources/users.rb | 4 +- rbi/knockapi/models/identify_user_request.rbi | 3 ++ .../models/inline_identify_user_request.rbi | 3 ++ rbi/knockapi/models/inline_object_request.rbi | 3 ++ rbi/knockapi/models/object_set_params.rbi | 4 ++ .../models/objects/bulk_set_params.rbi | 3 ++ .../models/recipients/channel_data.rbi | 41 ++++++++++++++++++- .../recipients/channel_data_request.rbi | 34 +++++++++++++++ .../inline_channel_data_request.rbi | 31 ++++++++++++++ rbi/knockapi/models/tenant_request.rbi | 3 ++ rbi/knockapi/models/tenant_set_params.rbi | 3 ++ rbi/knockapi/resources/objects.rbi | 2 + rbi/knockapi/resources/tenants.rbi | 1 + rbi/knockapi/resources/users.rbi | 2 + .../models/recipients/channel_data.rbs | 13 ++++++ .../recipients/channel_data_request.rbs | 11 +++++ .../inline_channel_data_request.rbs | 11 +++++ 30 files changed, 258 insertions(+), 30 deletions(-) diff --git a/.stats.yml b/.stats.yml index 9cbdb2d3..bfde4684 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 89 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-8d6bb1a0b221b8b9fb9aae94419c46e2e1ca4732281924f24c6539c006d12cb8.yml -openapi_spec_hash: 5dd6c9f3cac4f8cc602c0d1543ec4de4 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-2d3aac5f3ddf05db97231694fc7fab3f0f2abac4691944dd52bf5a250a4edaa5.yml +openapi_spec_hash: 6418b750ca4a74b7248e3913fefb0bed config_hash: 5c872aa99cad9b9602e84668f5b38a8a diff --git a/lib/knockapi/models/identify_user_request.rb b/lib/knockapi/models/identify_user_request.rb index 8a449a15..37b2256b 100644 --- a/lib/knockapi/models/identify_user_request.rb +++ b/lib/knockapi/models/identify_user_request.rb @@ -12,7 +12,7 @@ class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -79,7 +79,7 @@ class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel # # @param avatar [String, nil] A URL for the avatar of the user. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] The creation date of the user from your system. # diff --git a/lib/knockapi/models/inline_identify_user_request.rb b/lib/knockapi/models/inline_identify_user_request.rb index 98aa2fea..28f3e395 100644 --- a/lib/knockapi/models/inline_identify_user_request.rb +++ b/lib/knockapi/models/inline_identify_user_request.rb @@ -18,7 +18,7 @@ class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -88,7 +88,7 @@ class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel # # @param avatar [String, nil] A URL for the avatar of the user. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] The creation date of the user from your system. # diff --git a/lib/knockapi/models/inline_object_request.rb b/lib/knockapi/models/inline_object_request.rb index 6cab007b..45c0881a 100644 --- a/lib/knockapi/models/inline_object_request.rb +++ b/lib/knockapi/models/inline_object_request.rb @@ -18,7 +18,7 @@ class InlineObjectRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -51,7 +51,7 @@ class InlineObjectRequest < Knockapi::Internal::Type::BaseModel # # @param collection [String] The collection this object belongs to. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] Timestamp when the resource was created. # diff --git a/lib/knockapi/models/object_set_params.rb b/lib/knockapi/models/object_set_params.rb index e84f52ca..757245b1 100644 --- a/lib/knockapi/models/object_set_params.rb +++ b/lib/knockapi/models/object_set_params.rb @@ -10,7 +10,7 @@ class ObjectSetParams < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] } @@ -42,7 +42,7 @@ class ObjectSetParams < Knockapi::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Knockapi::Models::ObjectSetParams} for more details. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. # # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations # diff --git a/lib/knockapi/models/objects/bulk_set_params.rb b/lib/knockapi/models/objects/bulk_set_params.rb index 18f89ca7..9b8ce706 100644 --- a/lib/knockapi/models/objects/bulk_set_params.rb +++ b/lib/knockapi/models/objects/bulk_set_params.rb @@ -29,7 +29,7 @@ class Object < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -60,7 +60,7 @@ class Object < Knockapi::Internal::Type::BaseModel # # @param id [String] Unique identifier for the object. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] Timestamp when the resource was created. # diff --git a/lib/knockapi/models/recipients/channel_data.rb b/lib/knockapi/models/recipients/channel_data.rb index 90268ad7..87ea2a7d 100644 --- a/lib/knockapi/models/recipients/channel_data.rb +++ b/lib/knockapi/models/recipients/channel_data.rb @@ -19,7 +19,7 @@ class RecipientsChannelData < Knockapi::Internal::Type::BaseModel # @!attribute data # Channel data for a given channel type. # - # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData] + # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData] required :data, union: -> { Knockapi::Recipients::RecipientsChannelData::Data } # @!attribute provider @@ -35,7 +35,7 @@ class RecipientsChannelData < Knockapi::Internal::Type::BaseModel # # @param channel_id [String] The unique identifier for the channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData] Channel data for a given channel type. # # @param provider [Symbol, Knockapi::Models::Recipients::RecipientsChannelData::Provider] The type of provider. @@ -60,8 +60,29 @@ module Data # OneSignal channel data. variant -> { Knockapi::Recipients::OneSignalChannelData } + # AWS SNS push channel data. + variant -> { Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData } + + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + # @!attribute target_arns + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + # + # @return [Array] + required :target_arns, Knockapi::Internal::Type::ArrayOf[String] + + # @!method initialize(target_arns:) + # Some parameter documentations has been truncated, see + # {Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData} + # for more details. + # + # AWS SNS push channel data. + # + # @param target_arns [Array] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin + end + # @!method self.variants - # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData)] + # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData)] end # The type of provider. @@ -72,6 +93,7 @@ module Provider PUSH_FCM = :push_fcm PUSH_APNS = :push_apns + PUSH_AWS_SNS = :push_aws_sns PUSH_EXPO = :push_expo PUSH_ONE_SIGNAL = :push_one_signal CHAT_SLACK = :chat_slack diff --git a/lib/knockapi/models/recipients/channel_data_request.rb b/lib/knockapi/models/recipients/channel_data_request.rb index e1dfd93d..a6a25824 100644 --- a/lib/knockapi/models/recipients/channel_data_request.rb +++ b/lib/knockapi/models/recipients/channel_data_request.rb @@ -7,13 +7,13 @@ class ChannelDataRequest < Knockapi::Internal::Type::BaseModel # @!attribute data # Channel data for a given channel type. # - # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] + # @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] required :data, union: -> { Knockapi::Recipients::ChannelDataRequest::Data } # @!method initialize(data:) # A request to set channel data for a type of channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. # Channel data for a given channel type. # @@ -27,6 +27,9 @@ module Data # OneSignal channel data. variant -> { Knockapi::Recipients::OneSignalChannelData } + # AWS SNS push channel data. + variant -> { Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData } + # Slack channel data. variant -> { Knockapi::Recipients::SlackChannelData } @@ -36,8 +39,26 @@ module Data # Discord channel data. variant -> { Knockapi::Recipients::DiscordChannelData } + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + # @!attribute target_arns + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + # + # @return [Array] + required :target_arns, Knockapi::Internal::Type::ArrayOf[String] + + # @!method initialize(target_arns:) + # Some parameter documentations has been truncated, see + # {Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData} + # for more details. + # + # AWS SNS push channel data. + # + # @param target_arns [Array] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin + end + # @!method self.variants - # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] + # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] end end end diff --git a/lib/knockapi/models/recipients/inline_channel_data_request.rb b/lib/knockapi/models/recipients/inline_channel_data_request.rb index 613f9d3a..6bc83b31 100644 --- a/lib/knockapi/models/recipients/inline_channel_data_request.rb +++ b/lib/knockapi/models/recipients/inline_channel_data_request.rb @@ -13,6 +13,9 @@ module InlineChannelDataRequestItem # OneSignal channel data. variant -> { Knockapi::Recipients::OneSignalChannelData } + # AWS SNS push channel data. + variant -> { Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData } + # Slack channel data. variant -> { Knockapi::Recipients::SlackChannelData } @@ -22,8 +25,26 @@ module InlineChannelDataRequestItem # Discord channel data. variant -> { Knockapi::Recipients::DiscordChannelData } + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + # @!attribute target_arns + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + # + # @return [Array] + required :target_arns, Knockapi::Internal::Type::ArrayOf[String] + + # @!method initialize(target_arns:) + # Some parameter documentations has been truncated, see + # {Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData} + # for more details. + # + # AWS SNS push channel data. + # + # @param target_arns [Array] A list of platform endpoint ARNs. See [Setting up an Amazon SNS platform endpoin + end + # @!method self.variants - # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] + # @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)] end # @type [Knockapi::Internal::Type::Converter] diff --git a/lib/knockapi/models/tenant_request.rb b/lib/knockapi/models/tenant_request.rb index d4784dc7..8a4f64d8 100644 --- a/lib/knockapi/models/tenant_request.rb +++ b/lib/knockapi/models/tenant_request.rb @@ -12,7 +12,7 @@ class TenantRequest < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -44,7 +44,7 @@ class TenantRequest < Knockapi::Internal::Type::BaseModel # # @param id [String] The unique identifier for the tenant. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id. # diff --git a/lib/knockapi/models/tenant_set_params.rb b/lib/knockapi/models/tenant_set_params.rb index 8716050f..4e88ca89 100644 --- a/lib/knockapi/models/tenant_set_params.rb +++ b/lib/knockapi/models/tenant_set_params.rb @@ -10,7 +10,7 @@ class TenantSetParams < Knockapi::Internal::Type::BaseModel # @!attribute channel_data # A request to set channel data for a type of channel inline. # - # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] + # @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] optional :channel_data, -> { Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem] @@ -24,7 +24,7 @@ class TenantSetParams < Knockapi::Internal::Type::BaseModel optional :settings, -> { Knockapi::TenantSetParams::Settings } # @!method initialize(channel_data: nil, settings: nil, request_options: {}) - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set. # diff --git a/lib/knockapi/resources/objects.rb b/lib/knockapi/resources/objects.rb index ba90ef31..1f299ef4 100644 --- a/lib/knockapi/resources/objects.rb +++ b/lib/knockapi/resources/objects.rb @@ -368,7 +368,7 @@ def list_subscriptions(collection, object_id_, params = {}) # # @param id [String] Unique identifier for the object. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline. # # @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations # @@ -404,7 +404,7 @@ def set(collection, id, params = {}) # # @param channel_id [String] The unique identifier for the channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. # # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/knockapi/resources/tenants.rb b/lib/knockapi/resources/tenants.rb index c8ad3e25..63cbd9be 100644 --- a/lib/knockapi/resources/tenants.rb +++ b/lib/knockapi/resources/tenants.rb @@ -84,7 +84,7 @@ def get(id, params = {}) # # @param id [String] The unique identifier for the tenant. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param settings [Knockapi::Models::TenantSetParams::Settings] The settings for the tenant. Includes branding and preference set. # diff --git a/lib/knockapi/resources/users.rb b/lib/knockapi/resources/users.rb index 297ef65b..491e5a48 100644 --- a/lib/knockapi/resources/users.rb +++ b/lib/knockapi/resources/users.rb @@ -25,7 +25,7 @@ class Users # # @param avatar [String, nil] A URL for the avatar of the user. # - # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. + # @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline. # # @param created_at [Time, nil] The creation date of the user from your system. # @@ -354,7 +354,7 @@ def merge(user_id, params) # # @param channel_id [String] The unique identifier for the channel. # - # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. + # @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type. # # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/rbi/knockapi/models/identify_user_request.rbi b/rbi/knockapi/models/identify_user_request.rbi index c5a6bfd7..f19d7e9b 100644 --- a/rbi/knockapi/models/identify_user_request.rbi +++ b/rbi/knockapi/models/identify_user_request.rbi @@ -21,6 +21,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -82,6 +83,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -142,6 +144,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/inline_identify_user_request.rbi b/rbi/knockapi/models/inline_identify_user_request.rbi index 4a4c08be..feb3ccc9 100644 --- a/rbi/knockapi/models/inline_identify_user_request.rbi +++ b/rbi/knockapi/models/inline_identify_user_request.rbi @@ -28,6 +28,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -91,6 +92,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -154,6 +156,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/inline_object_request.rbi b/rbi/knockapi/models/inline_object_request.rbi index fe863c55..ea440d3e 100644 --- a/rbi/knockapi/models/inline_object_request.rbi +++ b/rbi/knockapi/models/inline_object_request.rbi @@ -25,6 +25,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -61,6 +62,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -105,6 +107,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/object_set_params.rbi b/rbi/knockapi/models/object_set_params.rbi index d8832020..7b3c3214 100644 --- a/rbi/knockapi/models/object_set_params.rbi +++ b/rbi/knockapi/models/object_set_params.rbi @@ -20,6 +20,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -38,6 +39,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -85,6 +87,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -125,6 +128,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/objects/bulk_set_params.rbi b/rbi/knockapi/models/objects/bulk_set_params.rbi index e4fffb00..6269dac5 100644 --- a/rbi/knockapi/models/objects/bulk_set_params.rbi +++ b/rbi/knockapi/models/objects/bulk_set_params.rbi @@ -62,6 +62,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -99,6 +100,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -140,6 +142,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/recipients/channel_data.rbi b/rbi/knockapi/models/recipients/channel_data.rbi index d0459603..b61d8294 100644 --- a/rbi/knockapi/models/recipients/channel_data.rbi +++ b/rbi/knockapi/models/recipients/channel_data.rbi @@ -55,7 +55,8 @@ module Knockapi Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash, - Knockapi::Recipients::OneSignalChannelData::OrHash + Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData::OrHash ), provider: Knockapi::Recipients::RecipientsChannelData::Provider::OrSymbol @@ -98,10 +99,41 @@ module Knockapi Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData, - Knockapi::Recipients::OneSignalChannelData + Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData ) end + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData, + Knockapi::Internal::AnyHash + ) + end + + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + sig { returns(T::Array[String]) } + attr_accessor :target_arns + + # AWS SNS push channel data. + sig do + params(target_arns: T::Array[String]).returns(T.attached_class) + end + def self.new( + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + target_arns: + ) + end + + sig { override.returns({ target_arns: T::Array[String] }) } + def to_hash + end + end + sig do override.returns( T::Array[ @@ -136,6 +168,11 @@ module Knockapi :push_apns, Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol ) + PUSH_AWS_SNS = + T.let( + :push_aws_sns, + Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol + ) PUSH_EXPO = T.let( :push_expo, diff --git a/rbi/knockapi/models/recipients/channel_data_request.rbi b/rbi/knockapi/models/recipients/channel_data_request.rbi index df815dcb..1c9429e6 100644 --- a/rbi/knockapi/models/recipients/channel_data_request.rbi +++ b/rbi/knockapi/models/recipients/channel_data_request.rbi @@ -18,6 +18,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -33,6 +34,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -52,6 +54,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -71,12 +74,43 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData ) end + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData, + Knockapi::Internal::AnyHash + ) + end + + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + sig { returns(T::Array[String]) } + attr_accessor :target_arns + + # AWS SNS push channel data. + sig do + params(target_arns: T::Array[String]).returns(T.attached_class) + end + def self.new( + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + target_arns: + ) + end + + sig { override.returns({ target_arns: T::Array[String] }) } + def to_hash + end + end + sig do override.returns( T::Array[Knockapi::Recipients::ChannelDataRequest::Data::Variants] diff --git a/rbi/knockapi/models/recipients/inline_channel_data_request.rbi b/rbi/knockapi/models/recipients/inline_channel_data_request.rbi index 8dc0189c..67ea4a1a 100644 --- a/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +++ b/rbi/knockapi/models/recipients/inline_channel_data_request.rbi @@ -12,12 +12,43 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData ) end + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, + Knockapi::Internal::AnyHash + ) + end + + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + sig { returns(T::Array[String]) } + attr_accessor :target_arns + + # AWS SNS push channel data. + sig do + params(target_arns: T::Array[String]).returns(T.attached_class) + end + def self.new( + # A list of platform endpoint ARNs. See + # [Setting up an Amazon SNS platform endpoint for mobile notifications](https://docs.aws.amazon.com/sns/latest/dg/mobile-platform-endpoint.html). + target_arns: + ) + end + + sig { override.returns({ target_arns: T::Array[String] }) } + def to_hash + end + end + sig do override.returns( T::Array[ diff --git a/rbi/knockapi/models/tenant_request.rbi b/rbi/knockapi/models/tenant_request.rbi index 16c39e00..afe4b43b 100644 --- a/rbi/knockapi/models/tenant_request.rbi +++ b/rbi/knockapi/models/tenant_request.rbi @@ -21,6 +21,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -60,6 +61,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -101,6 +103,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/models/tenant_set_params.rbi b/rbi/knockapi/models/tenant_set_params.rbi index 6f4e8e76..e0e34075 100644 --- a/rbi/knockapi/models/tenant_set_params.rbi +++ b/rbi/knockapi/models/tenant_set_params.rbi @@ -20,6 +20,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData @@ -46,6 +47,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -75,6 +77,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData diff --git a/rbi/knockapi/resources/objects.rbi b/rbi/knockapi/resources/objects.rbi index cfbeaa53..ae419c16 100644 --- a/rbi/knockapi/resources/objects.rbi +++ b/rbi/knockapi/resources/objects.rbi @@ -355,6 +355,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -402,6 +403,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash diff --git a/rbi/knockapi/resources/tenants.rbi b/rbi/knockapi/resources/tenants.rbi index 6ba629ab..f327b61e 100644 --- a/rbi/knockapi/resources/tenants.rbi +++ b/rbi/knockapi/resources/tenants.rbi @@ -72,6 +72,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash diff --git a/rbi/knockapi/resources/users.rbi b/rbi/knockapi/resources/users.rbi index dc33b6a3..754ba5e6 100644 --- a/rbi/knockapi/resources/users.rbi +++ b/rbi/knockapi/resources/users.rbi @@ -26,6 +26,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash @@ -344,6 +345,7 @@ module Knockapi T.any( Knockapi::Recipients::PushChannelData::OrHash, Knockapi::Recipients::OneSignalChannelData::OrHash, + Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData::OrHash, Knockapi::Recipients::SlackChannelData::OrHash, Knockapi::Recipients::MsTeamsChannelData::OrHash, Knockapi::Recipients::DiscordChannelData::OrHash diff --git a/sig/knockapi/models/recipients/channel_data.rbs b/sig/knockapi/models/recipients/channel_data.rbs index aa9e2087..a2f6e67f 100644 --- a/sig/knockapi/models/recipients/channel_data.rbs +++ b/sig/knockapi/models/recipients/channel_data.rbs @@ -42,16 +42,28 @@ module Knockapi | Knockapi::Recipients::MsTeamsChannelData | Knockapi::Recipients::DiscordChannelData | Knockapi::Recipients::OneSignalChannelData + | Knockapi::Recipients::RecipientsChannelData::Data::AwsSnsPushChannelData module Data extend Knockapi::Internal::Type::Union + type aws_sns_push_channel_data = { target_arns: ::Array[String] } + + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + attr_accessor target_arns: ::Array[String] + + def initialize: (target_arns: ::Array[String]) -> void + + def to_hash: -> { target_arns: ::Array[String] } + end + def self?.variants: -> ::Array[Knockapi::Models::Recipients::RecipientsChannelData::data] end type provider = :push_fcm | :push_apns + | :push_aws_sns | :push_expo | :push_one_signal | :chat_slack @@ -64,6 +76,7 @@ module Knockapi PUSH_FCM: :push_fcm PUSH_APNS: :push_apns + PUSH_AWS_SNS: :push_aws_sns PUSH_EXPO: :push_expo PUSH_ONE_SIGNAL: :push_one_signal CHAT_SLACK: :chat_slack diff --git a/sig/knockapi/models/recipients/channel_data_request.rbs b/sig/knockapi/models/recipients/channel_data_request.rbs index 4020802e..6b97bcea 100644 --- a/sig/knockapi/models/recipients/channel_data_request.rbs +++ b/sig/knockapi/models/recipients/channel_data_request.rbs @@ -18,6 +18,7 @@ module Knockapi type data = Knockapi::Recipients::PushChannelData | Knockapi::Recipients::OneSignalChannelData + | Knockapi::Recipients::ChannelDataRequest::Data::AwsSnsPushChannelData | Knockapi::Recipients::SlackChannelData | Knockapi::Recipients::MsTeamsChannelData | Knockapi::Recipients::DiscordChannelData @@ -25,6 +26,16 @@ module Knockapi module Data extend Knockapi::Internal::Type::Union + type aws_sns_push_channel_data = { target_arns: ::Array[String] } + + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + attr_accessor target_arns: ::Array[String] + + def initialize: (target_arns: ::Array[String]) -> void + + def to_hash: -> { target_arns: ::Array[String] } + end + def self?.variants: -> ::Array[Knockapi::Models::Recipients::ChannelDataRequest::data] end end diff --git a/sig/knockapi/models/recipients/inline_channel_data_request.rbs b/sig/knockapi/models/recipients/inline_channel_data_request.rbs index 29a17aec..a09a18c4 100644 --- a/sig/knockapi/models/recipients/inline_channel_data_request.rbs +++ b/sig/knockapi/models/recipients/inline_channel_data_request.rbs @@ -4,6 +4,7 @@ module Knockapi type inline_channel_data_request_item = Knockapi::Recipients::PushChannelData | Knockapi::Recipients::OneSignalChannelData + | Knockapi::Recipients::InlineChannelDataRequestItem::AwsSnsPushChannelData | Knockapi::Recipients::SlackChannelData | Knockapi::Recipients::MsTeamsChannelData | Knockapi::Recipients::DiscordChannelData @@ -11,6 +12,16 @@ module Knockapi module InlineChannelDataRequestItem extend Knockapi::Internal::Type::Union + type aws_sns_push_channel_data = { target_arns: ::Array[String] } + + class AwsSnsPushChannelData < Knockapi::Internal::Type::BaseModel + attr_accessor target_arns: ::Array[String] + + def initialize: (target_arns: ::Array[String]) -> void + + def to_hash: -> { target_arns: ::Array[String] } + end + def self?.variants: -> ::Array[Knockapi::Models::Recipients::inline_channel_data_request_item] end From 1d41369c045725172e6910a4fb4ee546218e55d3 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 10 Sep 2025 20:22:19 +0000 Subject: [PATCH 5/6] feat(api): api update --- .stats.yml | 4 ++-- .../models/users/guide_get_channel_response.rb | 10 +++++++++- .../models/users/guide_get_channel_response.rbi | 11 +++++++++++ .../models/users/guide_get_channel_response.rbs | 7 +++++++ 4 files changed, 29 insertions(+), 3 deletions(-) diff --git a/.stats.yml b/.stats.yml index bfde4684..e1347e42 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 89 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-2d3aac5f3ddf05db97231694fc7fab3f0f2abac4691944dd52bf5a250a4edaa5.yml -openapi_spec_hash: 6418b750ca4a74b7248e3913fefb0bed +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/knock%2Fknock-3f1e8172e76e9b64239788a7794aa29d1391e914ee3af7b596a5d1ea62555dd7.yml +openapi_spec_hash: 9ad2e5c838b52d2b7f95bb834fef35c4 config_hash: 5c872aa99cad9b9602e84668f5b38a8a diff --git a/lib/knockapi/models/users/guide_get_channel_response.rb b/lib/knockapi/models/users/guide_get_channel_response.rb index be2c9680..a96eeb89 100644 --- a/lib/knockapi/models/users/guide_get_channel_response.rb +++ b/lib/knockapi/models/users/guide_get_channel_response.rb @@ -32,6 +32,12 @@ class Guide < Knockapi::Internal::Type::BaseModel # @return [String, nil] optional :id, String + # @!attribute active + # Whether the guide is active. + # + # @return [Boolean, nil] + optional :active, Knockapi::Internal::Type::Boolean + # @!attribute content # The content of the guide. # @@ -50,9 +56,11 @@ class Guide < Knockapi::Internal::Type::BaseModel # @return [String, nil] optional :title, String - # @!method initialize(id: nil, content: nil, metadata: nil, title: nil) + # @!method initialize(id: nil, active: nil, content: nil, metadata: nil, title: nil) # @param id [String] The unique identifier for the guide. # + # @param active [Boolean] Whether the guide is active. + # # @param content [String] The content of the guide. # # @param metadata [Hash{Symbol=>Object}] The metadata of the guide. diff --git a/rbi/knockapi/models/users/guide_get_channel_response.rbi b/rbi/knockapi/models/users/guide_get_channel_response.rbi index c9938085..071f06bc 100644 --- a/rbi/knockapi/models/users/guide_get_channel_response.rbi +++ b/rbi/knockapi/models/users/guide_get_channel_response.rbi @@ -94,6 +94,13 @@ module Knockapi sig { params(id: String).void } attr_writer :id + # Whether the guide is active. + sig { returns(T.nilable(T::Boolean)) } + attr_reader :active + + sig { params(active: T::Boolean).void } + attr_writer :active + # The content of the guide. sig { returns(T.nilable(String)) } attr_reader :content @@ -118,6 +125,7 @@ module Knockapi sig do params( id: String, + active: T::Boolean, content: String, metadata: T::Hash[Symbol, T.anything], title: String @@ -126,6 +134,8 @@ module Knockapi def self.new( # The unique identifier for the guide. id: nil, + # Whether the guide is active. + active: nil, # The content of the guide. content: nil, # The metadata of the guide. @@ -139,6 +149,7 @@ module Knockapi override.returns( { id: String, + active: T::Boolean, content: String, metadata: T::Hash[Symbol, T.anything], title: String diff --git a/sig/knockapi/models/users/guide_get_channel_response.rbs b/sig/knockapi/models/users/guide_get_channel_response.rbs index 149c226c..52e52480 100644 --- a/sig/knockapi/models/users/guide_get_channel_response.rbs +++ b/sig/knockapi/models/users/guide_get_channel_response.rbs @@ -25,6 +25,7 @@ module Knockapi type guide = { id: String, + active: bool, content: String, metadata: ::Hash[Symbol, top], title: String @@ -35,6 +36,10 @@ module Knockapi def id=: (String) -> String + attr_reader active: bool? + + def active=: (bool) -> bool + attr_reader content: String? def content=: (String) -> String @@ -49,6 +54,7 @@ module Knockapi def initialize: ( ?id: String, + ?active: bool, ?content: String, ?metadata: ::Hash[Symbol, top], ?title: String @@ -56,6 +62,7 @@ module Knockapi def to_hash: -> { id: String, + active: bool, content: String, metadata: ::Hash[Symbol, top], title: String From 4a88126b03ce0bcb4b68e65d5a065abca3a1d722 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Wed, 10 Sep 2025 20:22:38 +0000 Subject: [PATCH 6/6] release: 1.13.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 12 ++++++++++++ Gemfile.lock | 2 +- README.md | 2 +- lib/knockapi/version.rb | 2 +- 5 files changed, 16 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index de0960ab..f94eeca2 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.12.0" + ".": "1.13.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 3d89cb8a..426d9ce0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Changelog +## 1.13.0 (2025-09-10) + +Full Changelog: [v1.12.0...v1.13.0](https://github.com/knocklabs/knock-ruby/compare/v1.12.0...v1.13.0) + +### Features + +* **api:** api update ([1d41369](https://github.com/knocklabs/knock-ruby/commit/1d41369c045725172e6910a4fb4ee546218e55d3)) +* **api:** api update ([4cbcd27](https://github.com/knocklabs/knock-ruby/commit/4cbcd27c56bf486d159ceefc0890014184aab50d)) +* **api:** api update ([4cd0c7d](https://github.com/knocklabs/knock-ruby/commit/4cd0c7d4541e1da08e5489df81b4732ff995e8cb)) +* **api:** api update ([2435936](https://github.com/knocklabs/knock-ruby/commit/243593653acf3381827206d7c3844350fb395fce)) +* **api:** api update ([ed2ca0f](https://github.com/knocklabs/knock-ruby/commit/ed2ca0f0d3d587b2fca1ff4a0fb3dcfec7b67b75)) + ## 1.12.0 (2025-09-02) Full Changelog: [v1.11.2...v1.12.0](https://github.com/knocklabs/knock-ruby/compare/v1.11.2...v1.12.0) diff --git a/Gemfile.lock b/Gemfile.lock index a0b2cb6f..3875a0f6 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - knockapi (1.12.0) + knockapi (1.13.0) connection_pool GEM diff --git a/README.md b/README.md index 5d1cc18a..58f2ad17 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "knockapi", "~> 1.12.0" +gem "knockapi", "~> 1.13.0" ``` diff --git a/lib/knockapi/version.rb b/lib/knockapi/version.rb index 34b808d0..71fb0547 100644 --- a/lib/knockapi/version.rb +++ b/lib/knockapi/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Knockapi - VERSION = "1.12.0" + VERSION = "1.13.0" end