trycourier 4.6.2 → 4.6.3

data/lib/courier/resources/profiles.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Profiles
+      # @return [Courier::Resources::Profiles::Lists]
+      attr_reader :lists
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::ProfileCreateParams} for more details.
+      #
+      # Merge the supplied values with an existing profile or create a new profile if
+      # one doesn't already exist.
+      #
+      # @overload create(user_id, profile:, request_options: {})
+      #
+      # @param user_id [String] A unique identifier representing the user associated with the requested profile.
+      #
+      # @param profile [Hash{Symbol=>Object}]
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::ProfileCreateResponse]
+      #
+      # @see Courier::Models::ProfileCreateParams
+      def create(user_id, params)
+        parsed, options = Courier::ProfileCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["profiles/%1$s", user_id],
+          body: parsed,
+          model: Courier::Models::ProfileCreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::ProfileRetrieveParams} for more details.
+      #
+      # Returns the specified user profile.
+      #
+      # @overload retrieve(user_id, request_options: {})
+      #
+      # @param user_id [String] A unique identifier representing the user associated with the requested profile.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::ProfileRetrieveResponse]
+      #
+      # @see Courier::Models::ProfileRetrieveParams
+      def retrieve(user_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["profiles/%1$s", user_id],
+          model: Courier::Models::ProfileRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::ProfileUpdateParams} for more details.
+      #
+      # Update a profile
+      #
+      # @overload update(user_id, patch:, request_options: {})
+      #
+      # @param user_id [String] A unique identifier representing the user associated with the requested user pro
+      #
+      # @param patch [Array<Courier::Models::ProfileUpdateParams::Patch>] List of patch operations to apply to the profile.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Courier::Models::ProfileUpdateParams
+      def update(user_id, params)
+        parsed, options = Courier::ProfileUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["profiles/%1$s", user_id],
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::ProfileDeleteParams} for more details.
+      #
+      # Deletes the specified user profile.
+      #
+      # @overload delete(user_id, request_options: {})
+      #
+      # @param user_id [String] A unique identifier representing the user associated with the requested user pro
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Courier::Models::ProfileDeleteParams
+      def delete(user_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["profiles/%1$s", user_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::ProfileReplaceParams} for more details.
+      #
+      # When using `PUT`, be sure to include all the key-value pairs required by the
+      # recipient's profile. Any key-value pairs that exist in the profile but fail to
+      # be included in the `PUT` request will be removed from the profile. Remember, a
+      # `PUT` update is a full replacement of the data. For partial updates, use the
+      # [Patch](https://www.courier.com/docs/reference/profiles/patch/) request.
+      #
+      # @overload replace(user_id, profile:, request_options: {})
+      #
+      # @param user_id [String] A unique identifier representing the user associated with the requested user pro
+      #
+      # @param profile [Hash{Symbol=>Object}]
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::ProfileReplaceResponse]
+      #
+      # @see Courier::Models::ProfileReplaceParams
+      def replace(user_id, params)
+        parsed, options = Courier::ProfileReplaceParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["profiles/%1$s", user_id],
+          body: parsed,
+          model: Courier::Models::ProfileReplaceResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Courier::Client]
+      def initialize(client:)
+        @client = client
+        @lists = Courier::Resources::Profiles::Lists.new(client: client)
+      end
+    end
+  end
+end

data/lib/courier/resources/requests.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Requests
+      # Archive message
+      #
+      # @overload archive(request_id, request_options: {})
+      #
+      # @param request_id [String] A unique identifier representing the request ID
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Courier::Models::RequestArchiveParams
+      def archive(request_id, params = {})
+        @client.request(
+          method: :put,
+          path: ["requests/%1$s/archive", request_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Courier::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/courier/resources/send.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Send
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::SendMessageParams} for more details.
+      #
+      # Send a message to one or more recipients.
+      #
+      # @overload message(message:, request_options: {})
+      #
+      # @param message [Courier::Models::SendMessageParams::Message] The message property has the following primary top-level properties. They define
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::SendMessageResponse]
+      #
+      # @see Courier::Models::SendMessageParams
+      def message(params)
+        parsed, options = Courier::SendMessageParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "send",
+          body: parsed,
+          model: Courier::Models::SendMessageResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Courier::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/courier/resources/tenants/preferences/items.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Tenants
+      class Preferences
+        class Items
+          # Some parameter documentations has been truncated, see
+          # {Courier::Models::Tenants::Preferences::ItemUpdateParams} for more details.
+          #
+          # Create or Replace Default Preferences For Topic
+          #
+          # @overload update(topic_id, tenant_id:, status:, custom_routing: nil, has_custom_routing: nil, request_options: {})
+          #
+          # @param topic_id [String] Path param: Id of the subscription topic you want to have a default preference f
+          #
+          # @param tenant_id [String] Path param: Id of the tenant to update the default preferences for.
+          #
+          # @param status [Symbol, Courier::Models::SubscriptionTopicNew::Status] Body param
+          #
+          # @param custom_routing [Array<Symbol, Courier::Models::ChannelClassification>, nil] Body param: The default channels to send to this tenant when has_custom_routing
+          #
+          # @param has_custom_routing [Boolean, nil] Body param: Override channel routing with custom preferences. This will override
+          #
+          # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see Courier::Models::Tenants::Preferences::ItemUpdateParams
+          def update(topic_id, params)
+            parsed, options = Courier::Tenants::Preferences::ItemUpdateParams.dump_request(params)
+            tenant_id =
+              parsed.delete(:tenant_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :put,
+              path: ["tenants/%1$s/default_preferences/items/%2$s", tenant_id, topic_id],
+              body: parsed,
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # Remove Default Preferences For Topic
+          #
+          # @overload delete(topic_id, tenant_id:, request_options: {})
+          #
+          # @param topic_id [String] Id of the subscription topic you want to have a default preference for.
+          #
+          # @param tenant_id [String] Id of the tenant to update the default preferences for.
+          #
+          # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see Courier::Models::Tenants::Preferences::ItemDeleteParams
+          def delete(topic_id, params)
+            parsed, options = Courier::Tenants::Preferences::ItemDeleteParams.dump_request(params)
+            tenant_id =
+              parsed.delete(:tenant_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :delete,
+              path: ["tenants/%1$s/default_preferences/items/%2$s", tenant_id, topic_id],
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Courier::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/courier/resources/tenants/preferences.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Tenants
+      class Preferences
+        # @return [Courier::Resources::Tenants::Preferences::Items]
+        attr_reader :items
+
+        # @api private
+        #
+        # @param client [Courier::Client]
+        def initialize(client:)
+          @client = client
+          @items = Courier::Resources::Tenants::Preferences::Items.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/courier/resources/tenants/templates.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Tenants
+      class Templates
+        # Get a Template in Tenant
+        #
+        # @overload retrieve(template_id, tenant_id:, request_options: {})
+        #
+        # @param template_id [String] Id of the template to be retrieved.
+        #
+        # @param tenant_id [String] Id of the tenant for which to retrieve the template.
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::BaseTemplateTenantAssociation]
+        #
+        # @see Courier::Models::Tenants::TemplateRetrieveParams
+        def retrieve(template_id, params)
+          parsed, options = Courier::Tenants::TemplateRetrieveParams.dump_request(params)
+          tenant_id =
+            parsed.delete(:tenant_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["tenants/%1$s/templates/%2$s", tenant_id, template_id],
+            model: Courier::BaseTemplateTenantAssociation,
+            options: options
+          )
+        end
+
+        # List Templates in Tenant
+        #
+        # @overload list(tenant_id, cursor: nil, limit: nil, request_options: {})
+        #
+        # @param tenant_id [String] Id of the tenant for which to retrieve the templates.
+        #
+        # @param cursor [String, nil] Continue the pagination with the next cursor
+        #
+        # @param limit [Integer, nil] The number of templates to return (defaults to 20, maximum value of 100)
+        #
+        # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Courier::Models::Tenants::TemplateListResponse]
+        #
+        # @see Courier::Models::Tenants::TemplateListParams
+        def list(tenant_id, params = {})
+          parsed, options = Courier::Tenants::TemplateListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["tenants/%1$s/templates", tenant_id],
+            query: parsed,
+            model: Courier::Models::Tenants::TemplateListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Courier::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/courier/resources/tenants.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Tenants
+      # @return [Courier::Resources::Tenants::Preferences]
+      attr_reader :preferences
+
+      # @return [Courier::Resources::Tenants::Templates]
+      attr_reader :templates
+
+      # Get a Tenant
+      #
+      # @overload retrieve(tenant_id, request_options: {})
+      #
+      # @param tenant_id [String] A unique identifier representing the tenant to be returned.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Tenant]
+      #
+      # @see Courier::Models::TenantRetrieveParams
+      def retrieve(tenant_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["tenants/%1$s", tenant_id],
+          model: Courier::Tenant,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::TenantUpdateParams} for more details.
+      #
+      # Create or Replace a Tenant
+      #
+      # @overload update(tenant_id, name:, brand_id: nil, default_preferences: nil, parent_tenant_id: nil, properties: nil, user_profile: nil, request_options: {})
+      #
+      # @param tenant_id [String] A unique identifier representing the tenant to be returned.
+      #
+      # @param name [String] Name of the tenant.
+      #
+      # @param brand_id [String, nil] Brand to be used for the account when one is not specified by the send call.
+      #
+      # @param default_preferences [Courier::Models::DefaultPreferences, nil] Defines the preferences used for the tenant when the user hasn't specified their
+      #
+      # @param parent_tenant_id [String, nil] Tenant's parent id (if any).
+      #
+      # @param properties [Hash{Symbol=>Object}, nil] Arbitrary properties accessible to a template.
+      #
+      # @param user_profile [Hash{Symbol=>Object}, nil] A user profile object merged with user profile on send.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Tenant]
+      #
+      # @see Courier::Models::TenantUpdateParams
+      def update(tenant_id, params)
+        parsed, options = Courier::TenantUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["tenants/%1$s", tenant_id],
+          body: parsed,
+          model: Courier::Tenant,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::TenantListParams} for more details.
+      #
+      # Get a List of Tenants
+      #
+      # @overload list(cursor: nil, limit: nil, parent_tenant_id: nil, request_options: {})
+      #
+      # @param cursor [String, nil] Continue the pagination with the next cursor
+      #
+      # @param limit [Integer, nil] The number of tenants to return
+      #
+      # @param parent_tenant_id [String, nil] Filter the list of tenants by parent_id
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::TenantListResponse]
+      #
+      # @see Courier::Models::TenantListParams
+      def list(params = {})
+        parsed, options = Courier::TenantListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "tenants",
+          query: parsed,
+          model: Courier::Models::TenantListResponse,
+          options: options
+        )
+      end
+
+      # Delete a Tenant
+      #
+      # @overload delete(tenant_id, request_options: {})
+      #
+      # @param tenant_id [String] Id of the tenant to be deleted.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Courier::Models::TenantDeleteParams
+      def delete(tenant_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["tenants/%1$s", tenant_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::TenantListUsersParams} for more details.
+      #
+      # Get Users in Tenant
+      #
+      # @overload list_users(tenant_id, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param tenant_id [String] Id of the tenant for user membership.
+      #
+      # @param cursor [String, nil] Continue the pagination with the next cursor
+      #
+      # @param limit [Integer, nil] The number of accounts to return
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::TenantListUsersResponse]
+      #
+      # @see Courier::Models::TenantListUsersParams
+      def list_users(tenant_id, params = {})
+        parsed, options = Courier::TenantListUsersParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["tenants/%1$s/users", tenant_id],
+          query: parsed,
+          model: Courier::Models::TenantListUsersResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Courier::Client]
+      def initialize(client:)
+        @client = client
+        @preferences = Courier::Resources::Tenants::Preferences.new(client: client)
+        @templates = Courier::Resources::Tenants::Templates.new(client: client)
+      end
+    end
+  end
+end

data/lib/courier/resources/translations.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    class Translations
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::TranslationRetrieveParams} for more details.
+      #
+      # Get translations by locale
+      #
+      # @overload retrieve(locale, domain:, request_options: {})
+      #
+      # @param locale [String] The locale you want to retrieve the translations for
+      #
+      # @param domain [String] The domain you want to retrieve translations for. Only `default` is supported at
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [String]
+      #
+      # @see Courier::Models::TranslationRetrieveParams
+      def retrieve(locale, params)
+        parsed, options = Courier::TranslationRetrieveParams.dump_request(params)
+        domain =
+          parsed.delete(:domain) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["translations/%1$s/%2$s", domain, locale],
+          model: String,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::TranslationUpdateParams} for more details.
+      #
+      # Update a translation
+      #
+      # @overload update(locale, domain:, body:, request_options: {})
+      #
+      # @param locale [String] Path param: The locale you want to retrieve the translations for
+      #
+      # @param domain [String] Path param: The domain you want to retrieve translations for. Only `default` is
+      #
+      # @param body [String] Body param
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Courier::Models::TranslationUpdateParams
+      def update(locale, params)
+        parsed, options = Courier::TranslationUpdateParams.dump_request(params)
+        domain =
+          parsed.delete(:domain) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :put,
+          path: ["translations/%1$s/%2$s", domain, locale],
+          body: parsed[:body],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Courier::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end