trycourier 4.6.2 → 4.6.3

data/lib/trycourier/resources/profiles.rb

@@ -1,150 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Resources
-    class Profiles
-      # @return [Trycourier::Resources::Profiles::Lists]
-      attr_reader :lists
-
-      # Some parameter documentations has been truncated, see
-      # {Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Trycourier::Models::ProfileCreateResponse]
-      #
-      # @see Trycourier::Models::ProfileCreateParams
-      def create(user_id, params)
-        parsed, options = Trycourier::ProfileCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: ["profiles/%1$s", user_id],
-          body: parsed,
-          model: Trycourier::Models::ProfileCreateResponse,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Trycourier::Models::ProfileRetrieveResponse]
-      #
-      # @see Trycourier::Models::ProfileRetrieveParams
-      def retrieve(user_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["profiles/%1$s", user_id],
-          model: Trycourier::Models::ProfileRetrieveResponse,
-          options: params[:request_options]
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Trycourier::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<Trycourier::Models::ProfileUpdateParams::Patch>] List of patch operations to apply to the profile.
-      #
-      # @param request_options [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [nil]
-      #
-      # @see Trycourier::Models::ProfileUpdateParams
-      def update(user_id, params)
-        parsed, options = Trycourier::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
-      # {Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [nil]
-      #
-      # @see Trycourier::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
-      # {Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Trycourier::Models::ProfileReplaceResponse]
-      #
-      # @see Trycourier::Models::ProfileReplaceParams
-      def replace(user_id, params)
-        parsed, options = Trycourier::ProfileReplaceParams.dump_request(params)
-        @client.request(
-          method: :put,
-          path: ["profiles/%1$s", user_id],
-          body: parsed,
-          model: Trycourier::Models::ProfileReplaceResponse,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Trycourier::Client]
-      def initialize(client:)
-        @client = client
-        @lists = Trycourier::Resources::Profiles::Lists.new(client: client)
-      end
-    end
-  end
-end

data/lib/trycourier/resources/requests.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [nil]
-      #
-      # @see Trycourier::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 [Trycourier::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/trycourier/resources/send.rb

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

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

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Resources
-    class Tenants
-      class Preferences
-        class Items
-          # Some parameter documentations has been truncated, see
-          # {Trycourier::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, Trycourier::Models::SubscriptionTopicNew::Status] Body param
-          #
-          # @param custom_routing [Array<Symbol, Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [nil]
-          #
-          # @see Trycourier::Models::Tenants::Preferences::ItemUpdateParams
-          def update(topic_id, params)
-            parsed, options = Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-          #
-          # @return [nil]
-          #
-          # @see Trycourier::Models::Tenants::Preferences::ItemDeleteParams
-          def delete(topic_id, params)
-            parsed, options = Trycourier::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 [Trycourier::Client]
-          def initialize(client:)
-            @client = client
-          end
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Trycourier::Models::BaseTemplateTenantAssociation]
-        #
-        # @see Trycourier::Models::Tenants::TemplateRetrieveParams
-        def retrieve(template_id, params)
-          parsed, options = Trycourier::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: Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Trycourier::Models::Tenants::TemplateListResponse]
-        #
-        # @see Trycourier::Models::Tenants::TemplateListParams
-        def list(tenant_id, params = {})
-          parsed, options = Trycourier::Tenants::TemplateListParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: ["tenants/%1$s/templates", tenant_id],
-            query: parsed,
-            model: Trycourier::Models::Tenants::TemplateListResponse,
-            options: options
-          )
-        end
-
-        # @api private
-        #
-        # @param client [Trycourier::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/trycourier/resources/tenants.rb

@@ -1,157 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Resources
-    class Tenants
-      # @return [Trycourier::Resources::Tenants::Preferences]
-      attr_reader :preferences
-
-      # @return [Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Trycourier::Models::Tenant]
-      #
-      # @see Trycourier::Models::TenantRetrieveParams
-      def retrieve(tenant_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["tenants/%1$s", tenant_id],
-          model: Trycourier::Tenant,
-          options: params[:request_options]
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Trycourier::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 [Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Trycourier::Models::Tenant]
-      #
-      # @see Trycourier::Models::TenantUpdateParams
-      def update(tenant_id, params)
-        parsed, options = Trycourier::TenantUpdateParams.dump_request(params)
-        @client.request(
-          method: :put,
-          path: ["tenants/%1$s", tenant_id],
-          body: parsed,
-          model: Trycourier::Tenant,
-          options: options
-        )
-      end
-
-      # Some parameter documentations has been truncated, see
-      # {Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Trycourier::Models::TenantListResponse]
-      #
-      # @see Trycourier::Models::TenantListParams
-      def list(params = {})
-        parsed, options = Trycourier::TenantListParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: "tenants",
-          query: parsed,
-          model: Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [nil]
-      #
-      # @see Trycourier::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
-      # {Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Trycourier::Models::TenantListUsersResponse]
-      #
-      # @see Trycourier::Models::TenantListUsersParams
-      def list_users(tenant_id, params = {})
-        parsed, options = Trycourier::TenantListUsersParams.dump_request(params)
-        @client.request(
-          method: :get,
-          path: ["tenants/%1$s/users", tenant_id],
-          query: parsed,
-          model: Trycourier::Models::TenantListUsersResponse,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Trycourier::Client]
-      def initialize(client:)
-        @client = client
-        @preferences = Trycourier::Resources::Tenants::Preferences.new(client: client)
-        @templates = Trycourier::Resources::Tenants::Templates.new(client: client)
-      end
-    end
-  end
-end

data/lib/trycourier/resources/translations.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module Trycourier
-  module Resources
-    class Translations
-      # Some parameter documentations has been truncated, see
-      # {Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [String]
-      #
-      # @see Trycourier::Models::TranslationRetrieveParams
-      def retrieve(locale, params)
-        parsed, options = Trycourier::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
-      # {Trycourier::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 [Trycourier::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [nil]
-      #
-      # @see Trycourier::Models::TranslationUpdateParams
-      def update(locale, params)
-        parsed, options = Trycourier::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 [Trycourier::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end