skykick 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e19ac5551a5eed6f335941a38736d4db275db2f296ae65e922f986755f5ca26
-  data.tar.gz: 103c52067a848103220e77b575b1a9faeb33312331ab3f8529b0c084b43e1ff6
+  metadata.gz: 2a6fddb22533868b7d481dab155eba199d22dc107614b504d7b30b2354a8f125
+  data.tar.gz: 4a91206b72d5ee286aa9bb974e4df2ef82631d26c4c9875c87da0308f82557fb
 SHA512:
-  metadata.gz: 90814f525c34d0970de21e27dca62e190fc2402596ed71052224a024d3b4bc1b5eb4f502255be8d4f2231b11a06bc432b1e29240eb6b6c791c09f8904d93b247
-  data.tar.gz: d4e4f31bd103929aa777b8c6d70f3bae5753fd51eed364d61173f9fcee7875d4ee67df88980c024d68f00f7d4efef704a8458cf726738a9871eb24763c4182e8
+  metadata.gz: b533bf98a520ca3aff074af183b8889807da2960a319dd4c5cf007491d4f49da0c15190671aeb11ccfc1c55842078453e0498f1d87271c8c28b81ea2cecca5d6
+  data.tar.gz: a1ba2fb65958104c88f603c893695b5d1f0c62081b578ec3a372c0e63da5f20db06b33fd29356c2025ad22e19a0d0f06679f040bc01a09191333ea69876e90f8

data/CHANGELOG.md

@@ -19,3 +19,7 @@
 ## [0.2.2] - 2025-03-21
 
 - updated documentation, filter subscription key from logs
+
+## [0.3.0] - 2025-09-01
+
+- updated api endpoint to https://apis.cloudservices.connectwise.com

data/README.md

@@ -7,7 +7,8 @@
 This is a wrapper for the Skykick Office365 backup API.
 You can see the [API endpoints](https://developers.skykick.com/apis)
 
-Currently only the GET requests to endpoints /Backup and /Alerts are implemented (readonly).
+Currently only the GET requests to endpoints /Backup and /Alerts
+are implemented (readonly).
 
 ## Installation
 
@@ -31,8 +32,8 @@ Or install it yourself as:
 
 ## Usage
 
-Before you start making the requests to API provide the client id and client secret and
-email/password using the configuration wrapping.
+Before you start making the requests to API provide the client id and client secret
+and email/password using the configuration wrapping.
 
 ```ruby
 require 'skykick'
@@ -63,7 +64,7 @@ client.login
 
 |Resource|API endpoint|
 |:--|:--|
-|.auth_token or .login|https://apis.skykick.com/auth/token|
+|.auth_token or .login|https://apis.cloudservices.connectwise.com/auth/token|
 
 ### Backup
 
@@ -75,18 +76,18 @@ subscriptions = client.subscriptions
 
 |Resource|API endpoint|
 |:--|:--|
-|autodiscover                     |https://apis.skykick.com/Backup/{id}/autodiscover                    |
-|datacenters                      |https://apis.skykick.com/Backup/datacenters                          |
-|exchange_mailboxe                |https://apis.skykick.com/Backup/{id}/mailboxes/{mailboxId}           |
-|exchange_mailboxes               |https://apis.skykick.com/Backup/{id}/mailboxes                       |
-|lastsnapshotstats                |https://apis.skykick.com/Backup/{backupServiceId}/lastsnapshotstats  |
-|retention_periods                |https://apis.skykick.com/Backup/{id}/retentionperiod                 |
-|sharePoint_sites                 |https://apis.skykick.com/Backup/{id}/sites                           |
-|sku                              |https://apis.skykick.com/Backup/{id}/sku                             |
-|storage_settings                 |https://apis.skykick.com/Backup/{id}/storagesettings                 |
-|subscription_settings            |https://apis.skykick.com/Backup/{id}/subscriptionsettings            |
-|subscriptions                    |https://apis.skykick.com/Backup/                                     |
-|partner_subscriptions(partner_id)|https://apis.skykick.com/Backup/{partner_id}                         |
+|autodiscover          |https://apis.cloudservices.connectwise.com/Backup/{id}/autodiscover|
+|datacenters           |https://apis.cloudservices.connectwise.com/Backup/datacenters|
+|exchange_mailboxe     |https://apis.cloudservices.connectwise.com/Backup/{id}/mailboxes/{mailboxId}|
+|exchange_mailboxes    |https://apis.cloudservices.connectwise.com/Backup/{id}/mailboxes|
+|lastsnapshotstats     |https://apis.cloudservices.connectwise.com/Backup/{backupServiceId}/lastsnapshotstats|
+|retention_periods     |https://apis.cloudservices.connectwise.com/Backup/{id}/retentionperiod|
+|sharePoint_sites      |https://apis.cloudservices.connectwise.com/Backup/{id}/sites|
+|sku                   |https://apis.cloudservices.connectwise.com/Backup/{id}/sku|
+|storage_settings      |https://apis.cloudservices.connectwise.com/Backup/{id}/storagesettings|
+|subscription_settings |https://apis.cloudservices.connectwise.com/Backup/{id}/subscriptionsettings|
+|subscriptions         |https://apis.cloudservices.connectwise.com/Backup/|
+|partner_subscriptions(partner_id)|https://apis.cloudservices.connectwise.com/Backup/{partner_id}|
 
 ### Alerts
 

data/lib/skykick/client/alerts.rb

@@ -1,19 +1,32 @@
+# frozen_string_literal: true
+
 module Skykick
   class Client
-
-    # All alert related api calls
-    # @see https://developers.skykick.com/
+    # Contains all alert-related API calls for managing alerts in Skykick.
+    # This module provides methods to retrieve alerts and mark them as complete.
+    #
+    # @see https://developers.skykick.com/ Skykick Developer Documentation
     module Alerts
-
-      # Returns first 500 Alerts for a provided Email Migration Order ID or Backup service ID.
+      # Retrieves the first 500 alerts for a given Email Migration Order ID or Backup Service ID.
+      # This method utilizes OData query parameters like `$top`, which defaults to 25 results
+      # and allows a maximum of 500 results per call.
+      #
+      # @note The `$top` query parameter is not explicitly implemented but can be configured on the endpoint.
+      # @param id [String] The unique identifier for an Email Migration Order or Backup Service.
+      # @return [Array<Hash>] A list of alerts associated with the specified ID.
+      # @example Retrieve alerts for a given order or service
+      #   client.alerts('12345')  # Returns up to 500 alerts
       def alerts(id)
-        # This endpoint supports the following OData query parameters: $top
-        # $top - default of 25 and max of 500 
-        # this is not implemented
+        # Retrieves paged results for alerts using the "Alerts" API endpoint.
         get_paged("Alerts/#{id}")
       end
 
-      # Mark an Alert as complete.
+      # Marks a specific alert as complete.
+      #
+      # @param id [String] The unique identifier for the alert to be marked as complete.
+      # @return [Hash] The response from the API after marking the alert as complete.
+      # @example Mark an alert as complete
+      #   client.mark_as_complete('alert123')  # Marks alert with ID 'alert123' as complete
       def mark_as_complete(id)
         post("Alerts/#{id}")
       end

data/lib/skykick/client/backup.rb

@@ -1,76 +1,123 @@
+# frozen_string_literal: true
+
 module Skykick
   class Client
-
-    # All backup related api calls
-    # @see https://developers.skykick.com/
+    # Contains all backup-related API calls for managing Skykick backup subscriptions and settings.
+    # This module provides methods to interact with backup services, including retrieving subscription
+    # settings, storage settings, and mailbox information.
+    #
+    # @see https://developers.skykick.com/ Skykick Developer Documentation
     module Backup
-
-      # Returns a list of supported Azure data centers.
+      # Retrieves a list of supported Azure data centers.
+      # @return [Array<Hash>] A list of Azure data centers supported by Skykick.
+      # @example Fetch available data centers
+      #   client.datacenters  # => Returns a list of supported data centers
       def datacenters
-          get('Backup/datacenters')
+        get('Backup/datacenters')
       end
 
-      # Gets a list of placed Backup subscription orders
-      def subscriptions()
-          get('Backup')
+      # Retrieves a list of placed Backup subscription orders.
+      # @return [Array<Hash>] A list of backup subscriptions.
+      # @example Get all backup subscriptions
+      #   client.subscriptions  # => Returns a list of placed backup subscription orders
+      def subscriptions
+        get('Backup')
       end
 
-      # Gets a list of placed Backup subscription orders
+      # Retrieves a list of backup subscription orders for a specific partner.
+      # @param partner_id [String] The unique identifier of the partner.
+      # @return [Array<Hash>] A list of partner-specific backup subscriptions.
+      # @example Get partner backup subscriptions
+      #   client.partner_subscriptions('partner123')  # => Returns subscriptions for the partner
       def partner_subscriptions(partner_id)
-          get("Backup/#{partner_id}")
+        get("Backup/#{partner_id}")
       end
 
-      # Returns Backup subscription settings. Settings include the enabled 
-      # state for Exchange and SharePoint Backups and total count of enabled
-      # Exchange mailboxes and SharePoint sites as well as the state of the subscription.
+      # Retrieves backup subscription settings, including the state of Exchange and SharePoint Backups,
+      # the number of enabled mailboxes and SharePoint sites, and the subscription state.
+      # @param id [String] The subscription ID.
+      # @return [Hash] Backup subscription settings.
+      # @example Fetch subscription settings
+      #   client.subscription_settings('sub123')  # => Returns backup subscription settings
       def subscription_settings(id)
-          get("Backup/#{id}/subscriptionsettings")
+        get("Backup/#{id}/subscriptionsettings")
       end
 
-      # Returns storage settings for a Backup subscription.
+      # Retrieves storage settings for a backup subscription.
+      # @param id [String] The subscription ID.
+      # @return [Hash] Storage settings for the specified subscription.
+      # @example Get storage settings
+      #   client.storage_settings('sub123')  # => Returns storage settings
       def storage_settings(id)
-          get("Backup/#{id}/storagesettings")
+        get("Backup/#{id}/storagesettings")
       end
 
-      # Gets SKU/promo details for a Backup service.
+      # Retrieves SKU or promotional details for a backup service.
+      # @param id [String] The subscription ID.
+      # @return [Hash] SKU or promotional details.
+      # @example Fetch SKU details
+      #   client.sku('sub123')  # => Returns SKU or promo details
       def sku(id)
-          get("Backup/#{id}/sku")
+        get("Backup/#{id}/sku")
       end
 
-      # Returns a list of SharePoint site URLs and statuses (enabled/disabled)
-      # for a Backup subscription.
+      # Retrieves a list of SharePoint site URLs and their statuses (enabled/disabled) for a backup subscription.
+      # @param id [String] The subscription ID.
+      # @return [Array<Hash>] A list of SharePoint site URLs and statuses.
+      # @example Get SharePoint sites
+      #   client.sharepoint_sites('sub123')  # => Returns a list of SharePoint sites and their statuses
       def sharepoint_sites(id)
-          get("Backup/#{id}/sites")
+        get("Backup/#{id}/sites")
       end
 
-      # Returns the data retention periods for a Backup subscription. There are different
-      # retention periods for Exchange and SharePoint Data.
+      # Retrieves the data retention periods for a backup subscription.
+      # Different retention periods apply for Exchange and SharePoint data.
       #
-      # Please Note: We are aware of the spelling error of the word "retention" in the response 
-      # field ExchangeRentionPeriodInDays. This is not a mistake in the documentation, but has 
-      # been left this way as not to disrupt any existing integrations with this endpoint.
+      # @note There is a known spelling issue in the response field: `ExchangeRentionPeriodInDays`.
+      #   This is intentional to avoid breaking existing integrations.
+      # @param id [String] The subscription ID.
+      # @return [Hash] Retention period details.
+      # @example Get retention periods
+      #   client.retentionperiod('sub123')  # => Returns retention periods for Exchange and SharePoint data
       def retentionperiod(id)
-          get("Backup/#{id}/retentionperiod")
+        get("Backup/#{id}/retentionperiod")
       end
 
-      # Gets stats for snapshots from SKDataWarehouse for all mailboxes of a given backupServiceId
+      # Retrieves snapshot statistics from SKDataWarehouse for all mailboxes in a given backup subscription.
+      # @param id [String] The subscription ID.
+      # @return [Hash] Snapshot statistics for the mailboxes.
+      # @example Fetch last snapshot stats
+      #   client.lastsnapshotstats('sub123')  # => Returns snapshot stats for the subscription's mailboxes
       def lastsnapshotstats(id)
-          get("Backup/#{id}/lastsnapshotstats")
+        get("Backup/#{id}/lastsnapshotstats")
       end
 
-      # Returns a list of Exchange mailboxes and statuses (enabled/disabled) for a Backup subscription.
+      # Retrieves a list of Exchange mailboxes and their statuses (enabled/disabled) for a backup subscription.
+      # @param id [String] The subscription ID.
+      # @return [Array<Hash>] A list of Exchange mailboxes and their statuses.
+      # @example Get Exchange mailboxes
+      #   client.exchange_mailboxes('sub123')  # => Returns a list of Exchange mailboxes and statuses
       def exchange_mailboxes(id)
-          get("Backup/#{id}/mailboxes")
+        get("Backup/#{id}/mailboxes")
       end
 
-      # Returns a list of Exchange mailboxes and statuses (enabled/disabled) for a Backup subscription.
+      # Retrieves details of a specific Exchange mailbox in a backup subscription.
+      # @param id [String] The subscription ID.
+      # @param mailbox_id [String] The unique identifier of the mailbox.
+      # @return [Hash] Details of the specified Exchange mailbox.
+      # @example Get details of a specific mailbox
+      #   client.exchange_mailbox('sub123', 'mailbox123')  # => Returns mailbox details
       def exchange_mailbox(id, mailbox_id)
-          get("Backup/#{id}/mailboxes/#{mailbox_id}")
+        get("Backup/#{id}/mailboxes/#{mailbox_id}")
       end
 
-      # Returns the Exchange and SharePoint auto-discover states (enabled/disabled) of a Backup subscription.
+      # Retrieves the auto-discover state (enabled/disabled) for Exchange and SharePoint backups in a subscription.
+      # @param id [String] The subscription ID.
+      # @return [Hash] Auto-discover states for Exchange and SharePoint.
+      # @example Check auto-discover state
+      #   client.autodiscover('sub123')  # => Returns the auto-discover state of the subscription
       def autodiscover(id)
-          get("Backup/#{id}/autodiscover")
+        get("Backup/#{id}/autodiscover")
       end
     end
   end

data/lib/skykick/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Skykick
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/skykick.rb

@@ -15,7 +15,7 @@ module Skykick
   extend WrAPI::RespondTo
 
   # Default API endpoint for the Skykick service.
-  DEFAULT_ENDPOINT = 'https://apis.skykick.com'
+  DEFAULT_ENDPOINT = 'https://apis.cloudservices.connectwise.com'
 
   # Default User-Agent header sent with API requests, including gem version information.
   DEFAULT_UA = "Skykick Ruby API wrapper #{Skykick::VERSION}"

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skykick
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Janco Tanis
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -93,6 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+description:
 email: gems@jancology.com
 executables: []
 extensions: []
@@ -122,6 +124,7 @@ licenses:
 metadata:
   homepage_uri: https://rubygems.org/gems/skykick
   source_code_uri: https://github.com/jancotanis/skykick
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,7 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A Ruby wrapper for the Skykick backup Portal REST APIs (readonly)
 test_files: []