trycourier 2.0.0 → 3.0.0.pre.beta1

data/lib/trycourier/tenants/types/default_preferences.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "subscription_topic"
+require "json"
+
+module Courier
+  class Tenants
+    class DefaultPreferences
+      attr_reader :items, :additional_properties
+
+      # @param items [Array<Tenants::SubscriptionTopic>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Tenants::DefaultPreferences]
+      def initialize(items:, additional_properties: nil)
+        # @type [Array<Tenants::SubscriptionTopic>]
+        @items = items
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of DefaultPreferences
+      #
+      # @param json_object [JSON]
+      # @return [Tenants::DefaultPreferences]
+      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
+          Tenants::SubscriptionTopic.from_json(json_object: v)
+        end
+        new(items: items, additional_properties: struct)
+      end
+
+      # Serialize an instance of DefaultPreferences to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "items": @items }.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.")
+      end
+    end
+  end
+end

data/lib/trycourier/tenants/types/list_users_for_tenant_response.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative "../../commons/types/user_tenant_association"
+require "json"
+
+module Courier
+  class Tenants
+    class ListUsersForTenantResponse
+      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 [Tenants::ListUsersForTenantResponse]
+      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 ListUsersForTenantResponse
+      #
+      # @param json_object [JSON]
+      # @return [Tenants::ListUsersForTenantResponse]
+      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 ListUsersForTenantResponse 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

data/lib/trycourier/tenants/types/subscription_topic.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "subscription_topic_status"
+require "json"
+
+module Courier
+  class Tenants
+    class SubscriptionTopic
+      attr_reader :id, :status, :additional_properties
+
+      # @param id [String] Topic ID
+      # @param status [Tenants::SubscriptionTopicStatus]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Tenants::SubscriptionTopic]
+      def initialize(id:, status:, additional_properties: nil)
+        # @type [String] Topic ID
+        @id = id
+        # @type [Tenants::SubscriptionTopicStatus]
+        @status = status
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of SubscriptionTopic
+      #
+      # @param json_object [JSON]
+      # @return [Tenants::SubscriptionTopic]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        id = struct.id
+        status = struct.status
+        new(id: id, status: status, additional_properties: struct)
+      end
+
+      # Serialize an instance of SubscriptionTopic to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "id": @id, "status": @status }.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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.status.is_a?(Tenants::SubscriptionTopicStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/tenants/types/subscription_topic_status.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Courier
+  class Tenants
+    class SubscriptionTopicStatus
+      OPTED_OUT = "OPTED_OUT"
+      OPTED_IN = "OPTED_IN"
+      REQUIRED = "REQUIRED"
+    end
+  end
+end

data/lib/trycourier/tenants/types/template_property.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Courier
+  class Tenants
+    TEMPLATE_PROPERTY = Object
+  end
+end

data/lib/trycourier/tenants/types/tenant.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "default_preferences"
+require_relative "template_property"
+require "json"
+
+module Courier
+  class Tenants
+    class Tenant
+      attr_reader :id, :name, :parent_tenant_id, :default_preferences, :properties, :user_profile, :brand_id,
+                  :additional_properties
+
+      # @param id [String] Id of the tenant.
+      # @param name [String] Name of the tenant.
+      # @param parent_tenant_id [String] Tenant's parent id (if any).
+      # @param default_preferences [Tenants::DefaultPreferences] Defines the preferences used for the account when the user hasn't specified their own.
+      # @param properties [Tenants::TEMPLATE_PROPERTY] Arbitrary properties accessible to a template.
+      # @param user_profile [Hash{String => String}] A user profile object merged with user profile on send.
+      # @param brand_id [String] Brand to be used for the account when one is not specified by the send call.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Tenants::Tenant]
+      def initialize(id:, name:, parent_tenant_id: nil, default_preferences: nil, properties: nil, user_profile: nil,
+                     brand_id: nil, additional_properties: nil)
+        # @type [String] Id of the tenant.
+        @id = id
+        # @type [String] Name of the tenant.
+        @name = name
+        # @type [String] Tenant's parent id (if any).
+        @parent_tenant_id = parent_tenant_id
+        # @type [Tenants::DefaultPreferences] Defines the preferences used for the account when the user hasn't specified their own.
+        @default_preferences = default_preferences
+        # @type [Tenants::TEMPLATE_PROPERTY] Arbitrary properties accessible to a template.
+        @properties = properties
+        # @type [Hash{String => String}] A user profile object merged with user profile on send.
+        @user_profile = user_profile
+        # @type [String] Brand to be used for the account when one is not specified by the send call.
+        @brand_id = brand_id
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of Tenant
+      #
+      # @param json_object [JSON]
+      # @return [Tenants::Tenant]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        id = struct.id
+        name = struct.name
+        parent_tenant_id = struct.parent_tenant_id
+        if parsed_json["default_preferences"].nil?
+          default_preferences = nil
+        else
+          default_preferences = parsed_json["default_preferences"].to_json
+          default_preferences = Tenants::DefaultPreferences.from_json(json_object: default_preferences)
+        end
+        properties = struct.properties
+        user_profile = struct.user_profile
+        brand_id = struct.brand_id
+        new(id: id, name: name, parent_tenant_id: parent_tenant_id, default_preferences: default_preferences,
+            properties: properties, user_profile: user_profile, brand_id: brand_id, additional_properties: struct)
+      end
+
+      # Serialize an instance of Tenant to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "id": @id,
+          "name": @name,
+          "parent_tenant_id": @parent_tenant_id,
+          "default_preferences": @default_preferences,
+          "properties": @properties,
+          "user_profile": @user_profile,
+          "brand_id": @brand_id
+        }.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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+        obj.parent_tenant_id&.is_a?(String) != false || raise("Passed value for field obj.parent_tenant_id is not the expected type, validation failed.")
+        obj.default_preferences.nil? || Tenants::DefaultPreferences.validate_raw(obj: obj.default_preferences)
+        obj.properties&.is_a?(Object) != false || raise("Passed value for field obj.properties is not the expected type, validation failed.")
+        obj.user_profile&.is_a?(Hash) != false || raise("Passed value for field obj.user_profile is not the expected type, validation failed.")
+        obj.brand_id&.is_a?(String) != false || raise("Passed value for field obj.brand_id is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/tenants/types/tenant_list_response.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "tenant"
+require "json"
+
+module Courier
+  class Tenants
+    class TenantListResponse
+      attr_reader :cursor, :has_more, :items, :next_url, :url, :type, :additional_properties
+
+      # @param cursor [String] A pointer to the next page of results. Defined only when has_more is set to true.
+      # @param has_more [Boolean] Set to true when there are more pages that can be retrieved.
+      # @param items [Array<Tenants::Tenant>] An array of Tenants
+      # @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 url [String] A url that may be used to generate these results.
+      # @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 [Tenants::TenantListResponse]
+      def initialize(has_more:, items:, url:, type:, cursor: nil, next_url: nil, additional_properties: nil)
+        # @type [String] A pointer to the next page of results. Defined only when has_more is set to true.
+        @cursor = cursor
+        # @type [Boolean] Set to true when there are more pages that can be retrieved.
+        @has_more = has_more
+        # @type [Array<Tenants::Tenant>] An array of Tenants
+        @items = items
+        # @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 url that may be used to generate these results.
+        @url = url
+        # @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 TenantListResponse
+      #
+      # @param json_object [JSON]
+      # @return [Tenants::TenantListResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        cursor = struct.cursor
+        has_more = struct.has_more
+        items = parsed_json["items"]&.map do |v|
+          v = v.to_json
+          Tenants::Tenant.from_json(json_object: v)
+        end
+        next_url = struct.next_url
+        url = struct.url
+        type = struct.type
+        new(cursor: cursor, has_more: has_more, items: items, next_url: next_url, url: url, type: type,
+            additional_properties: struct)
+      end
+
+      # Serialize an instance of TenantListResponse to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        {
+          "cursor": @cursor,
+          "has_more": @has_more,
+          "items": @items,
+          "next_url": @next_url,
+          "url": @url,
+          "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.cursor&.is_a?(String) != false || raise("Passed value for field obj.cursor 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.items.is_a?(Array) != false || raise("Passed value for field obj.items 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.url.is_a?(String) != false || raise("Passed value for field obj.url 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

data/lib/trycourier/translations/client.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require "async"
+
+module Courier
+  class TranslationsClient
+    attr_reader :request_client
+
+    # @param request_client [RequestClient]
+    # @return [TranslationsClient]
+    def initialize(request_client:)
+      # @type [RequestClient]
+      @request_client = request_client
+    end
+
+    # Get translations by locale
+    #
+    # @param domain [String] The domain you want to retrieve translations for. Only `default` is supported at the moment
+    # @param locale [String] The locale you want to retrieve the translations for
+    # @param request_options [RequestOptions]
+    # @return [String]
+    def get(domain:, locale:, request_options: nil)
+      response = @request_client.conn.get("/translations/#{domain}/#{locale}") 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
+      response.body
+    end
+
+    # Update a translation
+    #
+    # @param domain [String] The domain you want to retrieve translations for. Only `default` is supported at the moment
+    # @param locale [String] The locale you want to retrieve the translations for
+    # @param request [String] .po file translation content
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def update(domain:, locale:, request:, request_options: nil)
+      @request_client.conn.put("/translations/#{domain}/#{locale}") 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+      end
+    end
+  end
+
+  class AsyncTranslationsClient
+    attr_reader :request_client
+
+    # @param request_client [AsyncRequestClient]
+    # @return [AsyncTranslationsClient]
+    def initialize(request_client:)
+      # @type [AsyncRequestClient]
+      @request_client = request_client
+    end
+
+    # Get translations by locale
+    #
+    # @param domain [String] The domain you want to retrieve translations for. Only `default` is supported at the moment
+    # @param locale [String] The locale you want to retrieve the translations for
+    # @param request_options [RequestOptions]
+    # @return [String]
+    def get(domain:, locale:, request_options: nil)
+      Async do
+        response = @request_client.conn.get("/translations/#{domain}/#{locale}") 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
+        response.body
+      end
+    end
+
+    # Update a translation
+    #
+    # @param domain [String] The domain you want to retrieve translations for. Only `default` is supported at the moment
+    # @param locale [String] The locale you want to retrieve the translations for
+    # @param request [String] .po file translation content
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def update(domain:, locale:, request:, request_options: nil)
+      Async do
+        @request_client.conn.put("/translations/#{domain}/#{locale}") 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+        end
+      end
+    end
+  end
+end

data/lib/trycourier/types/send_message_response.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Courier
+  class SendMessageResponse
+    attr_reader :request_id, :additional_properties
+
+    # @param request_id [String] A successful call to `POST /send` returns a `202` status code along with a `requestId` in the response body.
+    #   For send requests that have a single recipient, the `requestId` is assigned to the derived message as its message_id. Therefore the `requestId` can be supplied to the Message's API for single recipient messages.
+    #   For send requests that have multiple recipients (accounts, audiences, lists, etc.), Courier assigns a unique id to each derived message as its `message_id`. Therefore the `requestId` cannot be supplied to the Message's API for single-recipient messages.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [SendMessageResponse]
+    def initialize(request_id:, additional_properties: nil)
+      # @type [String] A successful call to `POST /send` returns a `202` status code along with a `requestId` in the response body.
+      #   For send requests that have a single recipient, the `requestId` is assigned to the derived message as its message_id. Therefore the `requestId` can be supplied to the Message's API for single recipient messages.
+      #   For send requests that have multiple recipients (accounts, audiences, lists, etc.), Courier assigns a unique id to each derived message as its `message_id`. Therefore the `requestId` cannot be supplied to the Message's API for single-recipient messages.
+      @request_id = request_id
+      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @additional_properties = additional_properties
+    end
+
+    # Deserialize a JSON object to an instance of SendMessageResponse
+    #
+    # @param json_object [JSON]
+    # @return [SendMessageResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      JSON.parse(json_object)
+      request_id = struct.requestId
+      new(request_id: request_id, additional_properties: struct)
+    end
+
+    # Serialize an instance of SendMessageResponse to a JSON object
+    #
+    # @return [JSON]
+    def to_json(*_args)
+      { "requestId": @request_id }.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.request_id.is_a?(String) != false || raise("Passed value for field obj.request_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trycourier/users/client.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "preferences/client"
+require_relative "tenants/client"
+require_relative "tokens/client"
+
+module Courier
+  module Users
+    class Client
+      attr_reader :preferences, :tenants, :tokens
+
+      # @param request_client [RequestClient]
+      # @return [Users::Client]
+      def initialize(request_client:)
+        @preferences = Users::PreferencesClient.new(request_client: request_client)
+        @tenants = Users::TenantsClient.new(request_client: request_client)
+        @tokens = Users::TokensClient.new(request_client: request_client)
+      end
+    end
+
+    class AsyncClient
+      attr_reader :preferences, :tenants, :tokens
+
+      # @param request_client [RequestClient]
+      # @return [Users::AsyncClient]
+      def initialize(request_client:)
+        @preferences = Users::AsyncPreferencesClient.new(request_client: request_client)
+        @tenants = Users::AsyncTenantsClient.new(request_client: request_client)
+        @tokens = Users::AsyncTokensClient.new(request_client: request_client)
+      end
+    end
+  end
+end