trycourier 3.1.3 → 3.4.0.pre.alpha0

data/lib/trycourier/resources/lists/subscriptions.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Resources
+    class Lists
+      class Subscriptions
+        # Get the list's subscriptions.
+        #
+        # @overload list(list_id, cursor: nil, request_options: {})
+        #
+        # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+        #
+        # @param cursor [String, nil] A unique identifier that allows for fetching the next set of list subscriptions
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Trycourier::Models::Lists::SubscriptionListResponse]
+        #
+        # @see Trycourier::Models::Lists::SubscriptionListParams
+        def list(list_id, params = {})
+          parsed, options = Trycourier::Lists::SubscriptionListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["lists/%1$s/subscriptions", list_id],
+            query: parsed,
+            model: Trycourier::Models::Lists::SubscriptionListResponse,
+            options: options
+          )
+        end
+
+        # Subscribes additional users to the list, without modifying existing
+        # subscriptions. If the list does not exist, it will be automatically created.
+        #
+        # @overload add(list_id, recipients:, request_options: {})
+        #
+        # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+        #
+        # @param recipients [Array<Trycourier::Models::PutSubscriptionsRecipient>]
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Lists::SubscriptionAddParams
+        def add(list_id, params)
+          parsed, options = Trycourier::Lists::SubscriptionAddParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["lists/%1$s/subscriptions", list_id],
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Subscribes the users to the list, overwriting existing subscriptions. If the
+        # list does not exist, it will be automatically created.
+        #
+        # @overload subscribe(list_id, recipients:, request_options: {})
+        #
+        # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+        #
+        # @param recipients [Array<Trycourier::Models::PutSubscriptionsRecipient>]
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Lists::SubscriptionSubscribeParams
+        def subscribe(list_id, params)
+          parsed, options = Trycourier::Lists::SubscriptionSubscribeParams.dump_request(params)
+          @client.request(
+            method: :put,
+            path: ["lists/%1$s/subscriptions", list_id],
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Trycourier::Models::Lists::SubscriptionSubscribeUserParams} for more details.
+        #
+        # Subscribe a user to an existing list (note: if the List does not exist, it will
+        # be automatically created).
+        #
+        # @overload subscribe_user(user_id, list_id:, preferences: nil, request_options: {})
+        #
+        # @param user_id [String] Path param: A unique identifier representing the recipient associated with the l
+        #
+        # @param list_id [String] Path param: A unique identifier representing the list you wish to retrieve.
+        #
+        # @param preferences [Trycourier::Models::RecipientPreferences, nil] Body param:
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Lists::SubscriptionSubscribeUserParams
+        def subscribe_user(user_id, params)
+          parsed, options = Trycourier::Lists::SubscriptionSubscribeUserParams.dump_request(params)
+          list_id =
+            parsed.delete(:list_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["lists/%1$s/subscriptions/%2$s", list_id, user_id],
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Delete a subscription to a list by list ID and user ID.
+        #
+        # @overload unsubscribe_user(user_id, list_id:, request_options: {})
+        #
+        # @param user_id [String] A unique identifier representing the recipient associated with the list
+        #
+        # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Lists::SubscriptionUnsubscribeUserParams
+        def unsubscribe_user(user_id, params)
+          parsed, options = Trycourier::Lists::SubscriptionUnsubscribeUserParams.dump_request(params)
+          list_id =
+            parsed.delete(:list_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["lists/%1$s/subscriptions/%2$s", list_id, user_id],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Trycourier::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/resources/lists.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Resources
+    class Lists
+      # @return [Trycourier::Resources::Lists::Subscriptions]
+      attr_reader :subscriptions
+
+      # Returns a list based on the list ID provided.
+      #
+      # @overload retrieve(list_id, request_options: {})
+      #
+      # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Trycourier::Models::SubscriptionList]
+      #
+      # @see Trycourier::Models::ListRetrieveParams
+      def retrieve(list_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["lists/%1$s", list_id],
+          model: Trycourier::SubscriptionList,
+          options: params[:request_options]
+        )
+      end
+
+      # Create or replace an existing list with the supplied values.
+      #
+      # @overload update(list_id, name:, preferences: nil, request_options: {})
+      #
+      # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+      #
+      # @param name [String]
+      #
+      # @param preferences [Trycourier::Models::RecipientPreferences, nil]
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Trycourier::Models::ListUpdateParams
+      def update(list_id, params)
+        parsed, options = Trycourier::ListUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["lists/%1$s", list_id],
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Trycourier::Models::ListListParams} for more details.
+      #
+      # Returns all of the lists, with the ability to filter based on a pattern.
+      #
+      # @overload list(cursor: nil, pattern: nil, request_options: {})
+      #
+      # @param cursor [String, nil] A unique identifier that allows for fetching the next page of lists.
+      #
+      # @param pattern [String, nil] "A pattern used to filter the list items returned. Pattern types supported: exac
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Trycourier::Models::ListListResponse]
+      #
+      # @see Trycourier::Models::ListListParams
+      def list(params = {})
+        parsed, options = Trycourier::ListListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "lists",
+          query: parsed,
+          model: Trycourier::Models::ListListResponse,
+          options: options
+        )
+      end
+
+      # Delete a list by list ID.
+      #
+      # @overload delete(list_id, request_options: {})
+      #
+      # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Trycourier::Models::ListDeleteParams
+      def delete(list_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["lists/%1$s", list_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Restore a previously deleted list.
+      #
+      # @overload restore(list_id, request_options: {})
+      #
+      # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Trycourier::Models::ListRestoreParams
+      def restore(list_id, params = {})
+        @client.request(
+          method: :put,
+          path: ["lists/%1$s/restore", list_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Trycourier::Client]
+      def initialize(client:)
+        @client = client
+        @subscriptions = Trycourier::Resources::Lists::Subscriptions.new(client: client)
+      end
+    end
+  end
+end

data/lib/trycourier/resources/messages.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Resources
+    class Messages
+      # Some parameter documentations has been truncated, see
+      # {Trycourier::Models::MessageRetrieveParams} for more details.
+      #
+      # Fetch the status of a message you've previously sent.
+      #
+      # @overload retrieve(message_id, request_options: {})
+      #
+      # @param message_id [String] A unique identifier associated with the message you wish to retrieve (results fr
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Trycourier::Models::MessageRetrieveResponse]
+      #
+      # @see Trycourier::Models::MessageRetrieveParams
+      def retrieve(message_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["messages/%1$s", message_id],
+          model: Trycourier::Models::MessageRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Trycourier::Models::MessageListParams} for more details.
+      #
+      # Fetch the statuses of messages you've previously sent.
+      #
+      # @overload list(archived: nil, cursor: nil, enqueued_after: nil, event: nil, list: nil, message_id: nil, notification: nil, provider: nil, recipient: nil, status: nil, tag: nil, tags: nil, tenant_id: nil, trace_id: nil, request_options: {})
+      #
+      # @param archived [Boolean, nil] A boolean value that indicates whether archived messages should be included in t
+      #
+      # @param cursor [String, nil] A unique identifier that allows for fetching the next set of messages.
+      #
+      # @param enqueued_after [String, nil] The enqueued datetime of a message to filter out messages received before.
+      #
+      # @param event [String, nil] A unique identifier representing the event that was used to send the event.
+      #
+      # @param list [String, nil] A unique identifier representing the list the message was sent to.
+      #
+      # @param message_id [String, nil] A unique identifier representing the message_id returned from either /send or /s
+      #
+      # @param notification [String, nil] A unique identifier representing the notification that was used to send the even
+      #
+      # @param provider [Array<String, nil>] The key assocated to the provider you want to filter on. E.g., sendgrid, inbox,
+      #
+      # @param recipient [String, nil] A unique identifier representing the recipient associated with the requested pro
+      #
+      # @param status [Array<String, nil>] An indicator of the current status of the message. Allows multiple values to be
+      #
+      # @param tag [Array<String, nil>] A tag placed in the metadata.tags during a notification send. Allows multiple va
+      #
+      # @param tags [String, nil] A comma delimited list of 'tags'. Messages will be returned if they match any of
+      #
+      # @param tenant_id [String, nil] Messages sent with the context of a Tenant
+      #
+      # @param trace_id [String, nil] The unique identifier used to trace the requests
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Trycourier::Models::MessageListResponse]
+      #
+      # @see Trycourier::Models::MessageListParams
+      def list(params = {})
+        parsed, options = Trycourier::MessageListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "messages",
+          query: parsed.transform_keys(message_id: "messageId", trace_id: "traceId"),
+          model: Trycourier::Models::MessageListResponse,
+          options: options
+        )
+      end
+
+      # Cancel a message that is currently in the process of being delivered. A
+      # well-formatted API call to the cancel message API will return either `200`
+      # status code for a successful cancellation or `409` status code for an
+      # unsuccessful cancellation. Both cases will include the actual message record in
+      # the response body (see details below).
+      #
+      # @overload cancel(message_id, request_options: {})
+      #
+      # @param message_id [String] A unique identifier representing the message ID
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Trycourier::Models::MessageDetails]
+      #
+      # @see Trycourier::Models::MessageCancelParams
+      def cancel(message_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["messages/%1$s/cancel", message_id],
+          model: Trycourier::MessageDetails,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Trycourier::Models::MessageContentParams} for more details.
+      #
+      # Get message content
+      #
+      # @overload content(message_id, request_options: {})
+      #
+      # @param message_id [String] A unique identifier associated with the message you wish to retrieve (results fr
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Trycourier::Models::MessageContentResponse]
+      #
+      # @see Trycourier::Models::MessageContentParams
+      def content(message_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["messages/%1$s/output", message_id],
+          model: Trycourier::Models::MessageContentResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Fetch the array of events of a message you've previously sent.
+      #
+      # @overload history(message_id, type: nil, request_options: {})
+      #
+      # @param message_id [String] A unique identifier representing the message ID
+      #
+      # @param type [String, nil] A supported Message History type that will filter the events returned.
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Trycourier::Models::MessageHistoryResponse]
+      #
+      # @see Trycourier::Models::MessageHistoryParams
+      def history(message_id, params = {})
+        parsed, options = Trycourier::MessageHistoryParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["messages/%1$s/history", message_id],
+          query: parsed,
+          model: Trycourier::Models::MessageHistoryResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Trycourier::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/trycourier/resources/notifications/checks.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Resources
+    class Notifications
+      class Checks
+        # @overload update(submission_id, id:, checks:, request_options: {})
+        #
+        # @param submission_id [String] Path param:
+        #
+        # @param id [String] Path param:
+        #
+        # @param checks [Array<Trycourier::Models::BaseCheck>] Body param:
+        #
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Trycourier::Models::Notifications::CheckUpdateResponse]
+        #
+        # @see Trycourier::Models::Notifications::CheckUpdateParams
+        def update(submission_id, params)
+          parsed, options = Trycourier::Notifications::CheckUpdateParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :put,
+            path: ["notifications/%1$s/%2$s/checks", id, submission_id],
+            body: parsed,
+            model: Trycourier::Models::Notifications::CheckUpdateResponse,
+            options: options
+          )
+        end
+
+        # @overload list(submission_id, id:, request_options: {})
+        #
+        # @param submission_id [String]
+        # @param id [String]
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Trycourier::Models::Notifications::CheckListResponse]
+        #
+        # @see Trycourier::Models::Notifications::CheckListParams
+        def list(submission_id, params)
+          parsed, options = Trycourier::Notifications::CheckListParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["notifications/%1$s/%2$s/checks", id, submission_id],
+            model: Trycourier::Models::Notifications::CheckListResponse,
+            options: options
+          )
+        end
+
+        # @overload delete(submission_id, id:, request_options: {})
+        #
+        # @param submission_id [String]
+        # @param id [String]
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see Trycourier::Models::Notifications::CheckDeleteParams
+        def delete(submission_id, params)
+          parsed, options = Trycourier::Notifications::CheckDeleteParams.dump_request(params)
+          id =
+            parsed.delete(:id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["notifications/%1$s/%2$s/checks", id, submission_id],
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Trycourier::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/resources/notifications/draft.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Resources
+    class Notifications
+      class Draft
+        # @overload retrieve_content(id, request_options: {})
+        #
+        # @param id [String]
+        # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Trycourier::Models::NotificationGetContent]
+        #
+        # @see Trycourier::Models::Notifications::DraftRetrieveContentParams
+        def retrieve_content(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["notifications/%1$s/draft/content", id],
+            model: Trycourier::NotificationGetContent,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Trycourier::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/resources/notifications.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Trycourier
+  module Resources
+    class Notifications
+      # @return [Trycourier::Resources::Notifications::Draft]
+      attr_reader :draft
+
+      # @return [Trycourier::Resources::Notifications::Checks]
+      attr_reader :checks
+
+      # @overload list(cursor: nil, notes: nil, request_options: {})
+      #
+      # @param cursor [String, nil]
+      #
+      # @param notes [Boolean, nil] Retrieve the notes from the Notification template settings.
+      #
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Trycourier::Models::NotificationListResponse]
+      #
+      # @see Trycourier::Models::NotificationListParams
+      def list(params = {})
+        parsed, options = Trycourier::NotificationListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "notifications",
+          query: parsed,
+          model: Trycourier::Models::NotificationListResponse,
+          options: options
+        )
+      end
+
+      # @overload retrieve_content(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Trycourier::Models::NotificationGetContent]
+      #
+      # @see Trycourier::Models::NotificationRetrieveContentParams
+      def retrieve_content(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["notifications/%1$s/content", id],
+          model: Trycourier::NotificationGetContent,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Trycourier::Client]
+      def initialize(client:)
+        @client = client
+        @draft = Trycourier::Resources::Notifications::Draft.new(client: client)
+        @checks = Trycourier::Resources::Notifications::Checks.new(client: client)
+      end
+    end
+  end
+end