trycourier 3.1.3 → 3.4.0.pre.alpha0

data/lib/trycourier/users/tenants/client.rb

@@ -1,267 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../../requests"
-require_relative "../../commons/types/user_tenant_association"
-require_relative "types/add_user_to_single_tenants_params_profile"
-require_relative "types/list_tenants_for_user_response"
-require "async"
-
-module Courier
-  module Users
-    class TenantsClient
-      attr_reader :request_client
-
-      # @param request_client [RequestClient]
-      # @return [Users::TenantsClient]
-      def initialize(request_client:)
-        # @type [RequestClient]
-        @request_client = request_client
-      end
-
-      # This endpoint is used to add a user to
-      # multiple tenants in one call.
-      # A custom profile can also be supplied for each tenant.
-      # This profile will be merged with the user's main
-      # profile when sending to the user with that tenant.
-      #
-      # @param user_id [String] The user's ID. This can be any uniquely identifiable string.
-      # @param tenants [Array<Hash>] Request of type Array<Commons::UserTenantAssociation>, as a Hash
-      #   * :user_id (String)
-      #   * :type (String)
-      #   * :tenant_id (String)
-      #   * :profile (Hash{String => String})
-      # @param request_options [RequestOptions]
-      # @return [Void]
-      def add_multple(user_id:, tenants:, request_options: nil)
-        @request_client.conn.put("/users/#{user_id}/tenants") do |req|
-          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          unless request_options&.authorization_token.nil?
-            req.headers["Authorization"] =
-              request_options.authorization_token
-          end
-          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-          req.body = { **(request_options&.additional_body_parameters || {}), tenants: tenants }.compact
-        end
-      end
-
-      # This endpoint is used to add a single tenant.
-      #
-      # A custom profile can also be supplied with the tenant.
-      # This profile will be merged with the user's main profile
-      # when sending to the user with that tenant.
-      #
-      # @param user_id [String] Id of the user to be added to the supplied tenant.
-      # @param tenant_id [String] Id of the tenant the user should be added to.
-      # @param profile [Hash] Request of type Users::Tenants::AddUserToSingleTenantsParamsProfile, as a Hash
-      #   * :title (String)
-      #   * :email (String)
-      #   * :phone_number (String)
-      #   * :locale (String)
-      #   * :additional_fields (Hash{String => String})
-      # @param request_options [RequestOptions]
-      # @return [Void]
-      def add(user_id:, tenant_id:, profile:, request_options: nil)
-        @request_client.conn.put("/users/#{user_id}/tenants/#{tenant_id}") do |req|
-          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          unless request_options&.authorization_token.nil?
-            req.headers["Authorization"] =
-              request_options.authorization_token
-          end
-          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-          req.body = { **(request_options&.additional_body_parameters || {}), profile: profile }.compact
-        end
-      end
-
-      # Removes a user from any tenants they may have been associated with.
-      #
-      # @param user_id [String] Id of the user to be removed from the supplied tenant.
-      # @param request_options [RequestOptions]
-      # @return [Void]
-      def remove_all(user_id:, request_options: nil)
-        @request_client.conn.delete("/users/#{user_id}/tenants") do |req|
-          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          unless request_options&.authorization_token.nil?
-            req.headers["Authorization"] =
-              request_options.authorization_token
-          end
-          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-        end
-      end
-
-      # Removes a user from the supplied tenant.
-      #
-      # @param user_id [String] Id of the user to be removed from the supplied tenant.
-      # @param tenant_id [String] Id of the tenant the user should be removed from.
-      # @param request_options [RequestOptions]
-      # @return [Void]
-      def remove(user_id:, tenant_id:, request_options: nil)
-        @request_client.conn.delete("/users/#{user_id}/tenants/#{tenant_id}") do |req|
-          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          unless request_options&.authorization_token.nil?
-            req.headers["Authorization"] =
-              request_options.authorization_token
-          end
-          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-        end
-      end
-
-      # Returns a paginated list of user tenant associations.
-      #
-      # @param user_id [String] Id of the user to retrieve all associated tenants for.
-      # @param limit [Integer] The number of accounts to return
-      #   (defaults to 20, maximum value of 100)
-      # @param cursor [String] Continue the pagination with the next cursor
-      # @param request_options [RequestOptions]
-      # @return [Users::Tenants::ListTenantsForUserResponse]
-      def list(user_id:, limit: nil, cursor: nil, request_options: nil)
-        response = @request_client.conn.get("/users/#{user_id}/tenants") do |req|
-          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          unless request_options&.authorization_token.nil?
-            req.headers["Authorization"] =
-              request_options.authorization_token
-          end
-          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-          req.params = {
-            **(request_options&.additional_query_parameters || {}),
-            "limit": limit,
-            "cursor": cursor
-          }.compact
-        end
-        Users::Tenants::ListTenantsForUserResponse.from_json(json_object: response.body)
-      end
-    end
-
-    class AsyncTenantsClient
-      attr_reader :request_client
-
-      # @param request_client [AsyncRequestClient]
-      # @return [Users::AsyncTenantsClient]
-      def initialize(request_client:)
-        # @type [AsyncRequestClient]
-        @request_client = request_client
-      end
-
-      # This endpoint is used to add a user to
-      # multiple tenants in one call.
-      # A custom profile can also be supplied for each tenant.
-      # This profile will be merged with the user's main
-      # profile when sending to the user with that tenant.
-      #
-      # @param user_id [String] The user's ID. This can be any uniquely identifiable string.
-      # @param tenants [Array<Hash>] Request of type Array<Commons::UserTenantAssociation>, as a Hash
-      #   * :user_id (String)
-      #   * :type (String)
-      #   * :tenant_id (String)
-      #   * :profile (Hash{String => String})
-      # @param request_options [RequestOptions]
-      # @return [Void]
-      def add_multple(user_id:, tenants:, request_options: nil)
-        Async do
-          @request_client.conn.put("/users/#{user_id}/tenants") do |req|
-            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-            unless request_options&.authorization_token.nil?
-              req.headers["Authorization"] =
-                request_options.authorization_token
-            end
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-            req.body = { **(request_options&.additional_body_parameters || {}), tenants: tenants }.compact
-          end
-        end
-      end
-
-      # This endpoint is used to add a single tenant.
-      #
-      # A custom profile can also be supplied with the tenant.
-      # This profile will be merged with the user's main profile
-      # when sending to the user with that tenant.
-      #
-      # @param user_id [String] Id of the user to be added to the supplied tenant.
-      # @param tenant_id [String] Id of the tenant the user should be added to.
-      # @param profile [Hash] Request of type Users::Tenants::AddUserToSingleTenantsParamsProfile, as a Hash
-      #   * :title (String)
-      #   * :email (String)
-      #   * :phone_number (String)
-      #   * :locale (String)
-      #   * :additional_fields (Hash{String => String})
-      # @param request_options [RequestOptions]
-      # @return [Void]
-      def add(user_id:, tenant_id:, profile:, request_options: nil)
-        Async do
-          @request_client.conn.put("/users/#{user_id}/tenants/#{tenant_id}") do |req|
-            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-            unless request_options&.authorization_token.nil?
-              req.headers["Authorization"] =
-                request_options.authorization_token
-            end
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-            req.body = { **(request_options&.additional_body_parameters || {}), profile: profile }.compact
-          end
-        end
-      end
-
-      # Removes a user from any tenants they may have been associated with.
-      #
-      # @param user_id [String] Id of the user to be removed from the supplied tenant.
-      # @param request_options [RequestOptions]
-      # @return [Void]
-      def remove_all(user_id:, request_options: nil)
-        Async do
-          @request_client.conn.delete("/users/#{user_id}/tenants") do |req|
-            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-            unless request_options&.authorization_token.nil?
-              req.headers["Authorization"] =
-                request_options.authorization_token
-            end
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-          end
-        end
-      end
-
-      # Removes a user from the supplied tenant.
-      #
-      # @param user_id [String] Id of the user to be removed from the supplied tenant.
-      # @param tenant_id [String] Id of the tenant the user should be removed from.
-      # @param request_options [RequestOptions]
-      # @return [Void]
-      def remove(user_id:, tenant_id:, request_options: nil)
-        Async do
-          @request_client.conn.delete("/users/#{user_id}/tenants/#{tenant_id}") do |req|
-            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-            unless request_options&.authorization_token.nil?
-              req.headers["Authorization"] =
-                request_options.authorization_token
-            end
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-          end
-        end
-      end
-
-      # Returns a paginated list of user tenant associations.
-      #
-      # @param user_id [String] Id of the user to retrieve all associated tenants for.
-      # @param limit [Integer] The number of accounts to return
-      #   (defaults to 20, maximum value of 100)
-      # @param cursor [String] Continue the pagination with the next cursor
-      # @param request_options [RequestOptions]
-      # @return [Users::Tenants::ListTenantsForUserResponse]
-      def list(user_id:, limit: nil, cursor: nil, request_options: nil)
-        Async do
-          response = @request_client.conn.get("/users/#{user_id}/tenants") do |req|
-            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-            unless request_options&.authorization_token.nil?
-              req.headers["Authorization"] =
-                request_options.authorization_token
-            end
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-            req.params = {
-              **(request_options&.additional_query_parameters || {}),
-              "limit": limit,
-              "cursor": cursor
-            }.compact
-          end
-          Users::Tenants::ListTenantsForUserResponse.from_json(json_object: response.body)
-        end
-      end
-    end
-  end
-end

data/lib/trycourier/users/tenants/types/add_user_to_single_tenants_params_profile.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-module Courier
-  module Users
-    class Tenants
-      class AddUserToSingleTenantsParamsProfile
-        attr_reader :title, :email, :phone_number, :locale, :additional_fields, :additional_properties
-
-        # @param title [String]
-        # @param email [String] Email Address
-        # @param phone_number [String] A valid phone number
-        # @param locale [String] The user's preferred ISO 639-1 language code.
-        # @param additional_fields [Hash{String => String}] Additional provider specific fields may be specified.
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [Users::Tenants::AddUserToSingleTenantsParamsProfile]
-        def initialize(title:, email:, phone_number:, locale:, additional_fields:, additional_properties: nil)
-          # @type [String]
-          @title = title
-          # @type [String] Email Address
-          @email = email
-          # @type [String] A valid phone number
-          @phone_number = phone_number
-          # @type [String] The user's preferred ISO 639-1 language code.
-          @locale = locale
-          # @type [Hash{String => String}] Additional provider specific fields may be specified.
-          @additional_fields = additional_fields
-          # @type [OpenStruct] Additional properties unmapped to the current class definition
-          @additional_properties = additional_properties
-        end
-
-        # Deserialize a JSON object to an instance of AddUserToSingleTenantsParamsProfile
-        #
-        # @param json_object [JSON]
-        # @return [Users::Tenants::AddUserToSingleTenantsParamsProfile]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          JSON.parse(json_object)
-          title = struct.title
-          email = struct.email
-          phone_number = struct.phone_number
-          locale = struct.locale
-          additional_fields = struct.additional_fields
-          new(title: title, email: email, phone_number: phone_number, locale: locale,
-              additional_fields: additional_fields, additional_properties: struct)
-        end
-
-        # Serialize an instance of AddUserToSingleTenantsParamsProfile to a JSON object
-        #
-        # @return [JSON]
-        def to_json(*_args)
-          {
-            "title": @title,
-            "email": @email,
-            "phone_number": @phone_number,
-            "locale": @locale,
-            "additional_fields": @additional_fields
-          }.to_json
-        end
-
-        # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
-        #
-        # @param obj [Object]
-        # @return [Void]
-        def self.validate_raw(obj:)
-          obj.title.is_a?(String) != false || raise("Passed value for field obj.title is not the expected type, validation failed.")
-          obj.email.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
-          obj.phone_number.is_a?(String) != false || raise("Passed value for field obj.phone_number is not the expected type, validation failed.")
-          obj.locale.is_a?(String) != false || raise("Passed value for field obj.locale is not the expected type, validation failed.")
-          obj.additional_fields.is_a?(Hash) != false || raise("Passed value for field obj.additional_fields is not the expected type, validation failed.")
-        end
-      end
-    end
-  end
-end

data/lib/trycourier/users/tenants/types/list_tenants_for_user_response.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../../commons/types/user_tenant_association"
-require "json"
-
-module Courier
-  module Users
-    class Tenants
-      class ListTenantsForUserResponse
-        attr_reader :items, :has_more, :url, :next_url, :cursor, :type, :additional_properties
-
-        # @param items [Array<Commons::UserTenantAssociation>]
-        # @param has_more [Boolean] Set to true when there are more pages that can be retrieved.
-        # @param url [String] A url that may be used to generate these results.
-        # @param next_url [String] A url that may be used to generate fetch the next set of results.
-        #   Defined only when `has_more` is set to true
-        # @param cursor [String] A pointer to the next page of results. Defined
-        #   only when `has_more` is set to true
-        # @param type [String] Always set to `list`. Represents the type of this object.
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [Users::Tenants::ListTenantsForUserResponse]
-        def initialize(has_more:, url:, type:, items: nil, next_url: nil, cursor: nil, additional_properties: nil)
-          # @type [Array<Commons::UserTenantAssociation>]
-          @items = items
-          # @type [Boolean] Set to true when there are more pages that can be retrieved.
-          @has_more = has_more
-          # @type [String] A url that may be used to generate these results.
-          @url = url
-          # @type [String] A url that may be used to generate fetch the next set of results.
-          #   Defined only when `has_more` is set to true
-          @next_url = next_url
-          # @type [String] A pointer to the next page of results. Defined
-          #   only when `has_more` is set to true
-          @cursor = cursor
-          # @type [String] Always set to `list`. Represents the type of this object.
-          @type = type
-          # @type [OpenStruct] Additional properties unmapped to the current class definition
-          @additional_properties = additional_properties
-        end
-
-        # Deserialize a JSON object to an instance of ListTenantsForUserResponse
-        #
-        # @param json_object [JSON]
-        # @return [Users::Tenants::ListTenantsForUserResponse]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          parsed_json = JSON.parse(json_object)
-          items = parsed_json["items"]&.map do |v|
-            v = v.to_json
-            Commons::UserTenantAssociation.from_json(json_object: v)
-          end
-          has_more = struct.has_more
-          url = struct.url
-          next_url = struct.next_url
-          cursor = struct.cursor
-          type = struct.type
-          new(items: items, has_more: has_more, url: url, next_url: next_url, cursor: cursor, type: type,
-              additional_properties: struct)
-        end
-
-        # Serialize an instance of ListTenantsForUserResponse to a JSON object
-        #
-        # @return [JSON]
-        def to_json(*_args)
-          {
-            "items": @items,
-            "has_more": @has_more,
-            "url": @url,
-            "next_url": @next_url,
-            "cursor": @cursor,
-            "type": @type
-          }.to_json
-        end
-
-        # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
-        #
-        # @param obj [Object]
-        # @return [Void]
-        def self.validate_raw(obj:)
-          obj.items&.is_a?(Array) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
-          obj.has_more.is_a?(Boolean) != false || raise("Passed value for field obj.has_more is not the expected type, validation failed.")
-          obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
-          obj.next_url&.is_a?(String) != false || raise("Passed value for field obj.next_url is not the expected type, validation failed.")
-          obj.cursor&.is_a?(String) != false || raise("Passed value for field obj.cursor is not the expected type, validation failed.")
-          obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
-        end
-      end
-    end
-  end
-end