knockapi 1.0.0 → 1.1.0

data/lib/knockapi/resources/bulk_operations.rb

@@ -11,14 +11,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Models::BulkOperation]
+      # @return [Knockapi::BulkOperation]
       #
       # @see Knockapi::Models::BulkOperationGetParams
       def get(id, params = {})
         @client.request(
           method: :get,
           path: ["v1/bulk_operations/%1$s", id],
-          model: Knockapi::Models::BulkOperation,
+          model: Knockapi::BulkOperation,
           options: params[:request_options]
         )
       end

data/lib/knockapi/resources/channels/bulk.rb

@@ -16,13 +16,13 @@ module Knockapi
         #
         # @param channel_id [String] The ID of the channel to update messages for.
         #
-        # @param action [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action] The target status to be applied to the messages.
+        # @param action [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Action] The target status to be applied to the messages.
         #
-        # @param archived [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
+        # @param archived [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
         #
-        # @param delivery_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
+        # @param delivery_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
         #
-        # @param engagement_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
+        # @param engagement_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
         #
         # @param has_tenant [Boolean] Limits the results to messages that have a tenant or not.
         #
@@ -35,22 +35,21 @@ module Knockapi
         # @param tenants [Array<String>] Limits the results to messages with the given tenant IDs.
         #
         # @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
-        # ...
         #
         # @param workflows [Array<String>] Limits the results to messages with the given workflow keys.
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::Models::BulkOperation]
+        # @return [Knockapi::BulkOperation]
         #
         # @see Knockapi::Models::Channels::BulkUpdateMessageStatusParams
         def update_message_status(channel_id, action, params = {})
-          parsed, options = Knockapi::Models::Channels::BulkUpdateMessageStatusParams.dump_request(params)
+          parsed, options = Knockapi::Channels::BulkUpdateMessageStatusParams.dump_request(params)
           @client.request(
             method: :post,
             path: ["v1/channels/%1$s/messages/bulk/%2$s", channel_id, action],
             body: parsed,
-            model: Knockapi::Models::BulkOperation,
+            model: Knockapi::BulkOperation,
             options: options
           )
         end

data/lib/knockapi/resources/integrations/census.rb

@@ -22,7 +22,7 @@ module Knockapi
         #
         # @see Knockapi::Models::Integrations::CensusCustomDestinationParams
         def custom_destination(params)
-          parsed, options = Knockapi::Models::Integrations::CensusCustomDestinationParams.dump_request(params)
+          parsed, options = Knockapi::Integrations::CensusCustomDestinationParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v1/integrations/census/custom-destination",

data/lib/knockapi/resources/integrations/hightouch.rb

@@ -22,7 +22,7 @@ module Knockapi
         #
         # @see Knockapi::Models::Integrations::HightouchEmbeddedDestinationParams
         def embedded_destination(params)
-          parsed, options = Knockapi::Models::Integrations::HightouchEmbeddedDestinationParams.dump_request(params)
+          parsed, options = Knockapi::Integrations::HightouchEmbeddedDestinationParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v1/integrations/hightouch/embedded-destination",

data/lib/knockapi/resources/messages/batch.rb

@@ -13,16 +13,16 @@ module Knockapi
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Array<Knockapi::Models::Message>]
+        # @return [Array<Knockapi::Message>]
         #
         # @see Knockapi::Models::Messages::BatchArchiveParams
         def archive(params)
-          parsed, options = Knockapi::Models::Messages::BatchArchiveParams.dump_request(params)
+          parsed, options = Knockapi::Messages::BatchArchiveParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v1/messages/batch/archived",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -39,7 +39,7 @@ module Knockapi
         #
         # @see Knockapi::Models::Messages::BatchGetContentParams
         def get_content(params)
-          parsed, options = Knockapi::Models::Messages::BatchGetContentParams.dump_request(params)
+          parsed, options = Knockapi::Messages::BatchGetContentParams.dump_request(params)
           @client.request(
             method: :get,
             path: "v1/messages/batch/content",
@@ -63,16 +63,16 @@ module Knockapi
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Array<Knockapi::Models::Message>]
+        # @return [Array<Knockapi::Message>]
         #
         # @see Knockapi::Models::Messages::BatchMarkAsInteractedParams
         def mark_as_interacted(params)
-          parsed, options = Knockapi::Models::Messages::BatchMarkAsInteractedParams.dump_request(params)
+          parsed, options = Knockapi::Messages::BatchMarkAsInteractedParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v1/messages/batch/interacted",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -86,16 +86,16 @@ module Knockapi
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Array<Knockapi::Models::Message>]
+        # @return [Array<Knockapi::Message>]
         #
         # @see Knockapi::Models::Messages::BatchMarkAsReadParams
         def mark_as_read(params)
-          parsed, options = Knockapi::Models::Messages::BatchMarkAsReadParams.dump_request(params)
+          parsed, options = Knockapi::Messages::BatchMarkAsReadParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v1/messages/batch/read",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -110,16 +110,16 @@ module Knockapi
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Array<Knockapi::Models::Message>]
+        # @return [Array<Knockapi::Message>]
         #
         # @see Knockapi::Models::Messages::BatchMarkAsSeenParams
         def mark_as_seen(params)
-          parsed, options = Knockapi::Models::Messages::BatchMarkAsSeenParams.dump_request(params)
+          parsed, options = Knockapi::Messages::BatchMarkAsSeenParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v1/messages/batch/seen",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -134,16 +134,16 @@ module Knockapi
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Array<Knockapi::Models::Message>]
+        # @return [Array<Knockapi::Message>]
         #
         # @see Knockapi::Models::Messages::BatchMarkAsUnreadParams
         def mark_as_unread(params)
-          parsed, options = Knockapi::Models::Messages::BatchMarkAsUnreadParams.dump_request(params)
+          parsed, options = Knockapi::Messages::BatchMarkAsUnreadParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v1/messages/batch/unread",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -158,16 +158,16 @@ module Knockapi
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Array<Knockapi::Models::Message>]
+        # @return [Array<Knockapi::Message>]
         #
         # @see Knockapi::Models::Messages::BatchMarkAsUnseenParams
         def mark_as_unseen(params)
-          parsed, options = Knockapi::Models::Messages::BatchMarkAsUnseenParams.dump_request(params)
+          parsed, options = Knockapi::Messages::BatchMarkAsUnseenParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v1/messages/batch/unseen",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end
@@ -182,16 +182,16 @@ module Knockapi
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Array<Knockapi::Models::Message>]
+        # @return [Array<Knockapi::Message>]
         #
         # @see Knockapi::Models::Messages::BatchUnarchiveParams
         def unarchive(params)
-          parsed, options = Knockapi::Models::Messages::BatchUnarchiveParams.dump_request(params)
+          parsed, options = Knockapi::Messages::BatchUnarchiveParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v1/messages/batch/unarchived",
             body: parsed,
-            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
+            model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
             options: options
           )
         end

data/lib/knockapi/resources/messages.rb

@@ -6,9 +6,6 @@ module Knockapi
       # @return [Knockapi::Resources::Messages::Batch]
       attr_reader :batch
 
-      # @return [Knockapi::Resources::Messages::Activities]
-      attr_reader :activities
-
       # Some parameter documentations has been truncated, see
       # {Knockapi::Models::MessageListParams} for more details.
       #
@@ -22,44 +19,41 @@ module Knockapi
       #
       # @param channel_id [String] Limits the results to items with the corresponding channel ID.
       #
-      # @param engagement_status [Array<Symbol, Knockapi::Models::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
+      # @param engagement_status [Array<Symbol, Knockapi::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
       #
-      # @param inserted_at [Knockapi::Models::MessageListParams::InsertedAt]
+      # @param inserted_at [Knockapi::MessageListParams::InsertedAt]
       #
       # @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
-      # ...
       #
       # @param page_size [Integer] The number of items per page.
       #
       # @param source [String] Limits the results to messages triggered by the given workflow key.
       #
-      # @param status [Array<Symbol, Knockapi::Models::MessageListParams::Status>] Limits the results to messages with the given delivery status.
+      # @param status [Array<Symbol, Knockapi::MessageListParams::Status>] Limits the results to messages with the given delivery status.
       #
       # @param tenant [String] Limits the results to items with the corresponding tenant.
       #
       # @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
-      # ...
       #
       # @param workflow_categories [Array<String>] Limits the results to messages related to any of the provided categories.
       #
       # @param workflow_recipient_run_id [String] Limits the results to messages for a specific recipient's workflow run.
       #
       # @param workflow_run_id [String] Limits the results to messages associated with the top-level workflow run ID ret
-      # ...
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Message>]
+      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Message>]
       #
       # @see Knockapi::Models::MessageListParams
       def list(params = {})
-        parsed, options = Knockapi::Models::MessageListParams.dump_request(params)
+        parsed, options = Knockapi::MessageListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v1/messages",
           query: parsed,
           page: Knockapi::Internal::EntriesCursor,
-          model: Knockapi::Models::Message,
+          model: Knockapi::Message,
           options: options
         )
       end
@@ -73,14 +67,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Models::Message]
+      # @return [Knockapi::Message]
       #
       # @see Knockapi::Models::MessageArchiveParams
       def archive(message_id, params = {})
         @client.request(
           method: :put,
           path: ["v1/messages/%1$s/archived", message_id],
-          model: Knockapi::Models::Message,
+          model: Knockapi::Message,
           options: params[:request_options]
         )
       end
@@ -93,14 +87,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Models::Message]
+      # @return [Knockapi::Message]
       #
       # @see Knockapi::Models::MessageGetParams
       def get(message_id, params = {})
         @client.request(
           method: :get,
           path: ["v1/messages/%1$s", message_id],
-          model: Knockapi::Models::Message,
+          model: Knockapi::Message,
           options: params[:request_options]
         )
       end
@@ -142,17 +136,17 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::Activity>]
+      # @return [Knockapi::Internal::ItemsCursor<Knockapi::Activity>]
       #
       # @see Knockapi::Models::MessageListActivitiesParams
       def list_activities(message_id, params = {})
-        parsed, options = Knockapi::Models::MessageListActivitiesParams.dump_request(params)
+        parsed, options = Knockapi::MessageListActivitiesParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v1/messages/%1$s/activities", message_id],
           query: parsed,
           page: Knockapi::Internal::ItemsCursor,
-          model: Knockapi::Models::Activity,
+          model: Knockapi::Activity,
           options: options
         )
       end
@@ -171,17 +165,17 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::MessageDeliveryLog>]
+      # @return [Knockapi::Internal::EntriesCursor<Knockapi::MessageDeliveryLog>]
       #
       # @see Knockapi::Models::MessageListDeliveryLogsParams
       def list_delivery_logs(message_id, params = {})
-        parsed, options = Knockapi::Models::MessageListDeliveryLogsParams.dump_request(params)
+        parsed, options = Knockapi::MessageListDeliveryLogsParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v1/messages/%1$s/delivery_logs", message_id],
           query: parsed,
           page: Knockapi::Internal::EntriesCursor,
-          model: Knockapi::Models::MessageDeliveryLog,
+          model: Knockapi::MessageDeliveryLog,
           options: options
         )
       end
@@ -200,17 +194,17 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::MessageEvent>]
+      # @return [Knockapi::Internal::EntriesCursor<Knockapi::MessageEvent>]
       #
       # @see Knockapi::Models::MessageListEventsParams
       def list_events(message_id, params = {})
-        parsed, options = Knockapi::Models::MessageListEventsParams.dump_request(params)
+        parsed, options = Knockapi::MessageListEventsParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v1/messages/%1$s/events", message_id],
           query: parsed,
           page: Knockapi::Internal::EntriesCursor,
-          model: Knockapi::Models::MessageEvent,
+          model: Knockapi::MessageEvent,
           options: options
         )
       end
@@ -229,16 +223,16 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Models::Message]
+      # @return [Knockapi::Message]
       #
       # @see Knockapi::Models::MessageMarkAsInteractedParams
       def mark_as_interacted(message_id, params = {})
-        parsed, options = Knockapi::Models::MessageMarkAsInteractedParams.dump_request(params)
+        parsed, options = Knockapi::MessageMarkAsInteractedParams.dump_request(params)
         @client.request(
           method: :put,
           path: ["v1/messages/%1$s/interacted", message_id],
           body: parsed,
-          model: Knockapi::Models::Message,
+          model: Knockapi::Message,
           options: options
         )
       end
@@ -253,14 +247,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Models::Message]
+      # @return [Knockapi::Message]
       #
       # @see Knockapi::Models::MessageMarkAsReadParams
       def mark_as_read(message_id, params = {})
         @client.request(
           method: :put,
           path: ["v1/messages/%1$s/read", message_id],
-          model: Knockapi::Models::Message,
+          model: Knockapi::Message,
           options: params[:request_options]
         )
       end
@@ -275,14 +269,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Models::Message]
+      # @return [Knockapi::Message]
       #
       # @see Knockapi::Models::MessageMarkAsSeenParams
       def mark_as_seen(message_id, params = {})
         @client.request(
           method: :put,
           path: ["v1/messages/%1$s/seen", message_id],
-          model: Knockapi::Models::Message,
+          model: Knockapi::Message,
           options: params[:request_options]
         )
       end
@@ -297,14 +291,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Models::Message]
+      # @return [Knockapi::Message]
       #
       # @see Knockapi::Models::MessageMarkAsUnreadParams
       def mark_as_unread(message_id, params = {})
         @client.request(
           method: :delete,
           path: ["v1/messages/%1$s/read", message_id],
-          model: Knockapi::Models::Message,
+          model: Knockapi::Message,
           options: params[:request_options]
         )
       end
@@ -319,14 +313,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Models::Message]
+      # @return [Knockapi::Message]
       #
       # @see Knockapi::Models::MessageMarkAsUnseenParams
       def mark_as_unseen(message_id, params = {})
         @client.request(
           method: :delete,
           path: ["v1/messages/%1$s/seen", message_id],
-          model: Knockapi::Models::Message,
+          model: Knockapi::Message,
           options: params[:request_options]
         )
       end
@@ -340,14 +334,14 @@ module Knockapi
       #
       # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Knockapi::Models::Message]
+      # @return [Knockapi::Message]
       #
       # @see Knockapi::Models::MessageUnarchiveParams
       def unarchive(message_id, params = {})
         @client.request(
           method: :delete,
           path: ["v1/messages/%1$s/archived", message_id],
-          model: Knockapi::Models::Message,
+          model: Knockapi::Message,
           options: params[:request_options]
         )
       end
@@ -358,7 +352,6 @@ module Knockapi
       def initialize(client:)
         @client = client
         @batch = Knockapi::Resources::Messages::Batch.new(client: client)
-        @activities = Knockapi::Resources::Messages::Activities.new(client: client)
       end
     end
   end

data/lib/knockapi/resources/objects/bulk.rb

@@ -14,16 +14,16 @@ module Knockapi
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::Models::BulkOperation]
+        # @return [Knockapi::BulkOperation]
         #
         # @see Knockapi::Models::Objects::BulkDeleteParams
         def delete(collection, params)
-          parsed, options = Knockapi::Models::Objects::BulkDeleteParams.dump_request(params)
+          parsed, options = Knockapi::Objects::BulkDeleteParams.dump_request(params)
           @client.request(
             method: :post,
             path: ["v1/objects/%1$s/bulk/delete", collection],
             body: parsed,
-            model: Knockapi::Models::BulkOperation,
+            model: Knockapi::BulkOperation,
             options: options
           )
         end
@@ -38,20 +38,20 @@ module Knockapi
         #
         # @param collection [String] The collection this object belongs to.
         #
-        # @param subscriptions [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
+        # @param subscriptions [Array<Knockapi::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::Models::BulkOperation]
+        # @return [Knockapi::BulkOperation]
         #
         # @see Knockapi::Models::Objects::BulkAddSubscriptionsParams
         def add_subscriptions(collection, params)
-          parsed, options = Knockapi::Models::Objects::BulkAddSubscriptionsParams.dump_request(params)
+          parsed, options = Knockapi::Objects::BulkAddSubscriptionsParams.dump_request(params)
           @client.request(
             method: :post,
             path: ["v1/objects/%1$s/bulk/subscriptions/add", collection],
             body: parsed,
-            model: Knockapi::Models::BulkOperation,
+            model: Knockapi::BulkOperation,
             options: options
           )
         end
@@ -62,20 +62,20 @@ module Knockapi
         #
         # @param collection [String] The collection this object belongs to.
         #
-        # @param objects [Array<Knockapi::Models::InlineObjectRequest>] A list of objects.
+        # @param objects [Array<Knockapi::InlineObjectRequest>] A list of objects.
         #
         # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Knockapi::Models::BulkOperation]
+        # @return [Knockapi::BulkOperation]
         #
         # @see Knockapi::Models::Objects::BulkSetParams
         def set(collection, params)
-          parsed, options = Knockapi::Models::Objects::BulkSetParams.dump_request(params)
+          parsed, options = Knockapi::Objects::BulkSetParams.dump_request(params)
           @client.request(
             method: :post,
             path: ["v1/objects/%1$s/bulk/set", collection],
             body: parsed,
-            model: Knockapi::Models::BulkOperation,
+            model: Knockapi::BulkOperation,
             options: options
           )
         end