zm-ruby-client 3.0.1 → 3.1.0

data/sig/zm/client/admin_objects.rbs

@@ -0,0 +1,261 @@
+module Zm
+  module SoapRequest
+    class SoapElement
+    end
+
+    module RequestMethodsAdmin
+      def delete!: () -> nil
+      def modify!: () -> true
+      def update!: (?Hash[Symbol, untyped]? hash, ?update_attributes: bool, **untyped attrs) -> bool
+      def rename!: (String new_name) -> String
+
+      def build_create: () -> SoapElement
+      def build_modify: () -> SoapElement
+      def build_delete: () -> SoapElement
+      def build_rename: (String new_name) -> SoapElement
+    end
+  end
+
+  module Client
+    class Account < Base::MailboxObject
+      include SoapRequest::RequestMethodsAdmin
+
+      def cos: () -> Cos?
+      def create!: () -> String
+      def created_at: () -> Time?
+      def flush_cache!: () -> true
+      def attrs_write: () -> Array[String]
+      def batch: () -> BatchRequest
+      def empty_dumpster!: () -> untyped
+    end
+
+    class AccountsCollection < Base::AdminObjectsCollection[Account]
+      def quotas: (?domain_name: String?, ?target_server_id: String?) -> Array[untyped]?
+    end
+
+    class AccountAliasesCollection
+      def initialize: (Account parent) -> void
+
+      def all: () -> Array[String]
+      def add!: (String email) -> bool
+      def remove!: (String email) -> bool
+    end
+
+    class Resource < Base::MailboxObject
+      include SoapRequest::RequestMethodsAdmin
+
+      LOCATION: String
+      EQUIPMENT: String
+      TYPES: Array[String]
+
+      def create!: () -> String
+      def attrs_write: () -> Array[String]
+      def location?: () -> bool
+      def equipment?: () -> bool
+    end
+
+    class ResourcesCollection < Base::AdminObjectsCollection[Resource]
+    end
+
+    class Domain < Base::Object
+      include SoapRequest::RequestMethodsAdmin
+
+      def create!: () -> String
+      def cos: () -> Cos?
+      def attrs_write: () -> Array[String]
+      def DKIMPublicTxt: () -> String?
+
+      def accounts: () -> DomainAccountsCollection
+      def resources: () -> DomainResourcesCollection
+      def distribution_lists: () -> DomainDistributionListsCollection
+      alias distributionlists distribution_lists
+    end
+
+    class DomainsCollection < Base::AdminObjectsCollection[Domain]
+    end
+
+    class DomainAccountsCollection < AccountsCollection
+    end
+
+    class DomainResourcesCollection < ResourcesCollection
+    end
+
+    class DomainDistributionListsCollection < DistributionListsCollection
+    end
+
+    class Cos < Base::Object
+      def create!: () -> String
+      def modify!: () -> true
+      def update!: (?Hash[Symbol, untyped]? hash, ?update_attributes: bool, **untyped attrs) -> bool
+      def delete!: () -> nil
+      def clone!: (String new_name) -> String
+      def attrs_write: () -> Array[String]
+
+      def servers: () -> CosServersCollection
+      def domains: () -> CosDomainsCollection
+      def accounts: () -> CosAccountsCollection
+    end
+
+    class CosServersCollection
+      def initialize: (Cos parent) -> void
+
+      def all: () -> Array[Server]
+      alias all! all
+      def add!: (*(Server | Array[Server]) servers) -> bool
+      def remove!: (*(Server | Array[Server]) servers) -> bool
+    end
+
+    class CosDomainsCollection < DomainsCollection
+    end
+
+    class CosAccountsCollection < AccountsCollection
+    end
+
+    class CosesCollection < Base::AdminObjectsCollection[Cos]
+      def clone!: (String new_name) ?{ (Cos) -> void } -> String
+    end
+
+    class Server < Base::Object
+      def update!: (?Hash[Symbol, untyped]? hash, ?update_attributes: bool, **untyped attrs) -> bool
+      def mailboxes: () -> Array[Hash[Symbol, untyped]]?
+
+      def mta_queues: () -> MtaQueuesCollection
+      def backups: () -> BackupsCollection
+      def accounts: () -> ServerAccountsCollection
+    end
+
+    class MtaQueue < Base::Object
+      attr_accessor n: Integer?
+      alias nb_items n
+
+      def server: () -> Server
+      def hold!: (Array[String] ids) -> untyped
+      def release!: (Array[String] ids) -> untyped
+      def delete!: (Array[String] ids) -> untyped
+      def requeue!: (Array[String] ids) -> untyped
+    end
+
+    class MtaQueuesCollection < Base::ObjectsCollection[MtaQueue]
+      # The known queues without querying the server.
+      def defaults: () -> Array[MtaQueue]
+      def defaults!: () -> Array[MtaQueue]
+      # Raises Zm::Error::ZmError on an unknown queue name.
+      def find: (String queue_name) -> MtaQueue?
+    end
+
+    class Backup < Base::Object
+      attr_accessor label: String?
+      attr_accessor type: String?
+      attr_accessor aborted: bool?
+      attr_accessor start: Integer?
+      attr_accessor end: Integer?
+      attr_accessor minRedoSeq: Integer?
+      attr_accessor maxRedoSeq: Integer?
+      attr_accessor live: bool?
+      attr_accessor accounts: untyped
+      alias name label
+
+      def server: () -> Server
+      def start_at: () -> Time?
+      def end_at: () -> Time?
+      def full?: () -> bool
+      def incremental?: () -> bool
+    end
+
+    class BackupsCollection < Base::ObjectsCollection[Backup]
+    end
+
+    class ServerAccountsCollection < AccountsCollection
+    end
+
+    class ServersCollection < Base::AdminObjectsCollection[Server]
+      # Filters servers by enabled service (mailbox, mta, proxy...).
+      def where: (String service) -> self
+    end
+
+    class DistributionList < Base::Object
+      include SoapRequest::RequestMethodsAdmin
+
+      def create!: () -> String
+      def local_transport: () -> String
+      def local_transport!: () -> bool
+      def local_transport?: () -> bool
+      def external_transport?: () -> bool
+      def hide_in_gal?: () -> bool
+      def group?: () -> bool
+      def mailing_list?: () -> bool
+      def attrs_write: () -> Array[String]
+
+      def aliases: () -> DistributionListAliasesCollection
+      def members: () -> DistributionListMembersCollection
+      def owners: () -> DistributionListOwnersCollection
+      def memberships: () -> DlsMembershipCollection
+      def aces: () -> DistributionListAcesCollection
+    end
+
+    class DistributionListsCollection < Base::AdminObjectsCollection[DistributionList]
+    end
+
+    class DistributionListAliasesCollection
+      def initialize: (DistributionList parent) -> void
+
+      def all: () -> Array[String]
+      def add!: (String email) -> bool
+      def remove!: (String email) -> bool
+    end
+
+    class DistributionListMembersCollection
+      attr_accessor all: Array[String]
+
+      def initialize: (DistributionList parent) -> void
+
+      # Raises ArgumentError on nil, non-String or blank email.
+      def add!: (String | Array[String] emails) -> bool
+      def remove!: (String | Array[String] emails) -> bool
+    end
+
+    class DistributionListOwnersCollection
+      attr_accessor all: Array[String]
+
+      def initialize: (DistributionList parent) -> void
+
+      def add!: (*(String | Array[String]) emails) -> bool
+      def remove!: (*(String | Array[String]) emails) -> bool
+    end
+
+    class DlMembership < Data
+      attr_reader name: String
+      attr_reader id: String
+      attr_reader via: String?
+    end
+
+    class DlsMembershipCollection < Base::ObjectsCollection[DlMembership]
+    end
+
+    class DistributionListAcesCollection
+      class DistributionListAce < Data
+        attr_reader zimbra_id: String
+        attr_reader type: String
+        attr_reader right: String?
+      end
+
+      def initialize: (DistributionList parent) -> void
+
+      def all: () -> Array[DistributionListAce]
+    end
+
+    class Upload
+      def initialize: (String base_url, String token, ?is_token_admin: bool, **untyped rest_options) ?{ (Upload) -> void } -> void
+
+      def download_file: (String dest_file_path, String file_id, String? type, ?fmt: String?) -> nil
+      def read_file: (String file_id, String? type, ?fmt: String?) -> String
+      def download_files: (String dest_file_path, Array[String] file_ids, String? type, ?fmt: String?) -> nil
+      def download_attachment: (String dest_file_path, String message_id, String part) -> nil
+      def download_folder: (String dest_file_path, String folder_id, ?fmt: String?) -> nil
+      def send_file: (String src_file_path, String folder_id, ?fmt: String?, ?type: String?, ?resolve: String?) -> String
+      def upload_attachment: (String src_file_path) -> String
+      def download_file_with_url: (String url, String dest_file_path) -> nil
+      def same_origin?: (String url) -> bool
+    end
+  end
+end

data/sig/zm/client/base.rbs

@@ -0,0 +1,191 @@
+module Zm
+  module Client
+    module Base
+      class Object
+        attr_accessor parent: untyped
+        attr_accessor token: untyped
+        attr_accessor name: String?
+        attr_accessor id: String?
+        attr_accessor updated: bool
+
+        def initialize: (untyped parent) ?{ (self) -> void } -> void
+
+        def recorded?: () -> bool
+        def updated?: () -> bool
+        def save!: () -> untyped
+        def clone: () ?{ (self) -> void } -> self
+        def logger: () -> ::Logger
+        def update_attribute: (Symbol | String key, untyped value) -> void
+        def to_h: () -> Hash[Symbol, untyped]
+      end
+
+      # Collections are generic in signatures only: T is the type of the objects they build.
+      class ObjectsCollection[T]
+        attr_reader parent: untyped
+
+        def new: () ?{ (T) -> void } -> T
+        def find: (String id) -> T
+        def first: () -> T?
+        def all: () -> Array[T]
+        alias all! all
+
+        def per_page: (Integer? limit) -> self
+        alias limit per_page
+        def page: (Integer? offset) -> self
+        alias offset page
+        def order: (untyped sort_by, ?Integer sort_ascending) -> self
+
+        # Delegated to all through method_missing.
+        def each: () { (T) -> void } -> Array[T]
+        def map: [U] () { (T) -> U } -> Array[U]
+        def select: () { (T) -> boolish } -> Array[T]
+        def length: () -> Integer
+
+        def logger: () -> ::Logger
+      end
+
+      class AdminObjectsCollection[T] < ObjectsCollection[T]
+        ONERRORS: Array[String]
+
+        type onerror = "continue" | "stop"
+
+        def initialize: (untyped parent) -> void
+
+        def find_by: (Hash[Symbol, String] hash) -> T
+        def find_by!: (Hash[Symbol, String] hash) -> T
+        def find_by_or_nil: (Hash[Symbol, String] hash, ?singleton(StandardError) error_handler) -> T?
+
+        def ldap: () -> self
+        def where: (String ldap_query) -> self
+        def attrs: (*(String | Symbol | Array[String | Symbol]) attributes) -> self
+        def count: () -> Integer
+        def clear: () -> self
+
+        def find_each: (?offset: Integer, ?limit: Integer) { (T) -> void } -> void
+
+        def update_all!: (?Hash[Symbol, untyped]? hash, ?onerror: onerror, ?update_attributes: bool, **untyped attrs)
+                       -> Array[T]
+        def mass_update!: (Array[T | String] items, ?Hash[Symbol, untyped]? hash, ?onerror: onerror,
+                           ?update_attributes: bool, **untyped attrs) -> Array[T]
+        def delete_all!: (?onerror: onerror) -> Array[T]
+        def mass_delete!: (Array[T | String] items, ?onerror: onerror) -> Array[T]
+      end
+
+      class AccountObjectsCollection[T] < ObjectsCollection[T]
+        def initialize: (untyped parent) -> void
+      end
+
+      class AccountSearchObjectsCollection[T] < AccountObjectsCollection[T]
+        attr_accessor more: bool
+
+        def find: (String id) -> T
+        def start_at: (Time | Date start_at) -> self
+        def end_at: (Time | Date end_at) -> self
+        def folders: (*(Folder | Array[Folder]) folders) -> self
+        def folder_ids: (*(String | Array[String]) folder_ids) -> self
+        def where: (String query) -> self
+        def order: (String sort_by) -> self
+        def ids: () -> Array[String]
+        def reset: () -> void
+        def delete_all: (Array[String] ids) -> untyped
+      end
+
+      class ZimbraAttribute
+        attr_reader name: String
+        attr_reader type: String?
+        attr_reader objects_scope: Array[String]
+
+        def immutable?: () -> bool
+      end
+
+      class ZimbraAttributesCollection
+        attr_reader path: String
+        attr_reader all: Array[ZimbraAttribute]
+
+        def self.shared: (Cluster parent) -> ZimbraAttributesCollection
+
+        def initialize: (Cluster parent) -> void
+
+        def all_account_attrs: () -> Array[ZimbraAttribute]
+        def all_account_attrs_writable_names: () -> Array[String]
+        def all_cos_attrs: () -> Array[ZimbraAttribute]
+        def all_cos_attrs_writable_names: () -> Array[String]
+        def all_domain_attrs: () -> Array[ZimbraAttribute]
+        def all_domain_attrs_writable_names: () -> Array[String]
+        def all_server_attrs: () -> Array[ZimbraAttribute]
+        def all_server_attrs_writable_names: () -> Array[String]
+        def all_distributionlist_attrs: () -> Array[ZimbraAttribute]
+        def all_distributionlist_attrs_writable_names: () -> Array[String]
+        def all_resource_attrs: () -> Array[ZimbraAttribute]
+        def all_resource_attrs_writable_names: () -> Array[String]
+      end
+
+      class MailboxObject < Object
+        attr_accessor home_url: String?
+        attr_accessor public_url: String?
+        attr_accessor password: String?
+        attr_writer used: Integer
+        attr_writer domain_key: String?
+
+        def soap_account_connector: () -> Connector::SoapAccountConnector
+        def soap_connector: () -> Connector::SoapBaseConnector
+        def soap_admin_connector: () -> Connector::SoapAdminConnector
+        alias sac soap_admin_connector
+
+        def domain_name: () -> String
+        def used: () -> Integer?
+        def used!: () -> Integer?
+        def mbxid: () -> Integer?
+        def mbxid!: () -> Integer?
+
+        def token: () -> Token?
+        def token=: (String value) -> void
+        def logged?: () -> bool
+        def alive?: () -> bool
+        def logged_and_alive?: () -> bool
+        def domain_key: () -> String?
+
+        # Delegate auth when the cluster is logged, else password or preauth.
+        def login: () -> void
+        def account_login: () -> void
+        def account_login_preauth: (?Integer expires) -> void
+        def account_login_password: () -> void
+        def admin_login: () -> void
+
+        def password!: (?String? new_password) -> (String | false)
+        def local_transport: () -> String
+        def local_transport!: () -> untyped
+        def is_local_transport?: () -> bool
+        def is_external_transport?: () -> bool
+        def last_logon: () -> Time?
+
+        def build_uploader: () -> Upload
+        def rest_url: () -> String
+
+        def aliases: () -> AccountAliasesCollection
+        def infos: () -> MailboxInfosCollection
+        def prefs: () -> MailboxPrefsCollection
+        def messages: () -> MessagesCollection
+        def folders: () -> FoldersCollection
+        def mount_points: () -> MountPointsCollection
+        alias mountpoints mount_points
+        def search_folders: () -> SearchFoldersCollection
+        def identities: () -> IdentitiesCollection
+        def shares: () -> SharesCollection
+        def contacts: () -> ContactsCollection
+        def appointments: () -> AppointmentsCollection
+        def tags: () -> TagsCollection
+        def tasks: () -> TasksCollection
+        def aces: () -> AcesCollection
+        alias rights aces
+        def signatures: () -> SignaturesCollection
+        def documents: () -> DocumentsCollection
+        def memberships: () -> AccountDlsMembershipCollection
+        def dls_owner: () -> AccountDlsOwnerCollection
+        def filter_rules: () -> FilterRulesCollection
+        def outgoing_filter_rules: () -> OutgoingFilterRulesCollection
+        def data_sources: () -> DataSourcesCollection
+      end
+    end
+  end
+end

data/sig/zm/client/cluster.rbs

@@ -0,0 +1,152 @@
+module Zm
+  module Client
+    type cache_store = [Symbol] | [Symbol, Hash[Symbol, untyped]]
+
+    # Anything Logger can write to: a file path, $stdout, a StringIO...
+    interface _LogDevice
+      def write: (*untyped) -> untyped
+      def close: () -> untyped
+    end
+    type count_object_type = :userAccount | :account | :alias | :dl | :domain | :cos | :server | :calresource
+                           | :internalUserAccount
+
+    class ClusterConfig
+      BASE_URL_REGEX: Regexp
+
+      attr_reader zimbra_admin_url: String?
+      attr_reader zimbra_public_url: String?
+      attr_writer logger: ::Logger
+      attr_writer colorize_logging: bool
+      attr_accessor zimbra_admin_login: String?
+      attr_accessor zimbra_admin_password: String?
+      attr_accessor domains: Array[ClusterConfigDomain]
+      attr_accessor zimbra_version: String
+      attr_accessor log_path: String | _LogDevice
+      attr_accessor timeout: Integer
+      attr_accessor ssl_verify: bool
+      attr_accessor ssl_ca_file: String?
+      attr_accessor ssl_ca_path: String?
+
+      def initialize: (?(String | Hash[Symbol, untyped])? parameters) ?{ (ClusterConfig) -> void } -> void
+
+      def cache: () -> Support::Cache::Store
+      def cache_store: () -> cache_store
+      def cache_store=: (cache_store options) -> void
+      def ssl_options: () -> Hash[Symbol, untyped]
+
+      def zimbra_admin_url=: (String url) -> void
+      def zimbra_public_url=: (String url) -> void
+
+      def find_domain: (String domain_name) -> ClusterConfigDomain?
+      def domain_key: (String domain_name) -> String?
+      def has_admin_credentials?: () -> bool
+
+      def zimbra_attributes_path: () -> String
+      def zimbra_attributes_path=: (String path) -> void
+
+      def logger: () -> ::Logger
+      def log_level=: (Integer level) -> void
+    end
+
+    class ClusterConfigDomain < Data
+      attr_reader name: String
+      attr_reader key: String?
+
+      def self.new: (String name, String? key) -> instance
+                  | (name: String, key: String?) -> instance
+    end
+
+    class ClusterConfigError < StandardError
+    end
+
+    class Cluster
+      attr_reader soap_admin_connector: Connector::SoapAdminConnector
+      attr_reader config: ClusterConfig
+      attr_reader zimbra_attributes: Base::ZimbraAttributesCollection
+      attr_reader type: String?
+      attr_reader version: String?
+      attr_reader release: String?
+      attr_reader buildDate: String?
+      attr_reader host: String?
+      attr_reader majorversion: String?
+      attr_reader minorversion: String?
+      attr_reader microversion: String?
+
+      def initialize: (ClusterConfig config) -> void
+
+      def has_admin_credentials?: () -> bool
+      def token: () -> Token?
+      def token=: (String value) -> void
+
+      # Raises ClusterConfigError without admin credentials, Zm::Error::AuthError on bad credentials.
+      def login: () -> void
+      def logged?: () -> bool
+      def alive?: () -> bool
+      def logged_and_alive?: () -> bool
+
+      def license: () -> License?
+
+      def domains: () -> DomainsCollection
+      def accounts: () -> AccountsCollection
+      def resources: () -> ResourcesCollection
+      def servers: () -> ServersCollection
+      def coses: () -> CosesCollection
+      def distribution_lists: () -> DistributionListsCollection
+      alias distributionlists distribution_lists
+
+      def domain_key: (String domain_name) -> String?
+      def count_object: (count_object_type | String type) -> Integer
+      def email_exist?: (String email) -> bool
+      def infos!: () -> void
+      def logger: () -> ::Logger
+      def batch: () -> BatchRequest
+    end
+
+    class Token
+      def initialize: (String str) -> void
+
+      def to_s: () -> String
+      def decoded: () -> String
+      def metadatas: () -> Hash[String, String?]
+      def zimbra_id: () -> String?
+      def admin?: () -> bool
+      def server_version: () -> String?
+      def expire_at: () -> Time
+      def expired?: () -> bool
+    end
+
+    class License < Base::Object
+    end
+
+    class BatchRequest
+      ONERRORS: Array[String]
+
+      attr_reader requests: Array[untyped]
+
+      def initialize: (Connector::SoapBaseConnector connector) -> void
+      def invoke: (?onerror: "continue" | "stop") -> Array[untyped]
+    end
+  end
+
+  module Connector
+    class SoapBaseConnector
+    end
+
+    class SoapAdminConnector < SoapBaseConnector
+    end
+
+    class SoapAccountConnector < SoapBaseConnector
+    end
+  end
+
+  module Support
+    module Cache
+      class Store
+      end
+
+      def self.registered_storage: () -> Hash[Symbol, Symbol | singleton(Store)]
+      def self.register_storage: (Symbol key, Symbol | singleton(Store) klass) -> void
+      def self.storage: (Symbol key) -> singleton(Store)?
+    end
+  end
+end