activitysmith 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 24b950498feeab02ee3010ff54e2dd9146459f1e33d213eedead7adf4a9fefe4
+  data.tar.gz: a69fc0f24e473e7166275b5513eaed670b074cca3f3228458888cf6a025f3040
+SHA512:
+  metadata.gz: a0185af8b6b7addc83df57e83de2996df14c1f4f0f2602d9fc4ab4e9115b787494f4034f99be0286a2546aea7d39d9bf129490632db341a805ec9d2f4819bab7
+  data.tar.gz: dc7cc4627d1247a9027b581c261e54401b1683247bb1bd1f5416f4ea3c172135445b0d72a95284a249715b1cc035b39a466f96488ca345c98d0ce7eb22e73516

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ActivitySmith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,116 @@
+# ActivitySmith Ruby SDK
+
+The ActivitySmith Ruby SDK provides convenient access to the ActivitySmith API from Ruby applications.
+
+## Documentation
+
+See [API reference](https://activitysmith.com/docs/api-reference/introduction).
+
+## Installation
+
+```sh
+gem install activitysmith
+```
+
+## Setup
+
+```ruby
+require "activitysmith"
+
+activitysmith = ActivitySmith::Client.new(api_key: ENV.fetch("ACTIVITYSMITH_API_KEY"))
+```
+
+## Usage
+
+### Send a Push Notification
+
+```ruby
+response = activitysmith.notifications.send(
+  {
+    title: "Build Failed",
+    message: "CI pipeline failed on main branch"
+  }
+)
+
+puts response.success
+puts response.devices_notified
+```
+
+### Start a Live Activity
+
+```ruby
+start = activitysmith.live_activities.start(
+  {
+    content_state: {
+      title: "ActivitySmith API Deployment",
+      subtitle: "start",
+      number_of_steps: 4,
+      current_step: 1,
+      type: "segmented_progress",
+      color: "yellow"
+    }
+  }
+)
+
+activity_id = start.activity_id
+```
+
+### Update a Live Activity
+
+```ruby
+update = activitysmith.live_activities.update(
+  {
+    activity_id: activity_id,
+    content_state: {
+      title: "ActivitySmith API Deployment",
+      subtitle: "npm i & pm2",
+      current_step: 3
+    }
+  }
+)
+
+puts update.devices_notified
+```
+
+### End a Live Activity
+
+```ruby
+finish = activitysmith.live_activities.end(
+  {
+    activity_id: activity_id,
+    content_state: {
+      title: "ActivitySmith API Deployment",
+      subtitle: "done",
+      current_step: 4,
+      auto_dismiss_minutes: 3
+    }
+  }
+)
+
+puts finish.success
+```
+
+## Error Handling
+
+```ruby
+begin
+  activitysmith.notifications.send(
+    { title: "Build Failed" }
+  )
+rescue OpenapiClient::ApiError => err
+  puts "Request failed: #{err.code} #{err.message}"
+end
+```
+
+## API Surface
+
+- `activitysmith.notifications`
+- `activitysmith.live_activities`
+
+## Requirements
+
+- Ruby 3.0+
+
+## License
+
+MIT

data/generated/activitysmith_openapi/api/live_activities_api.rb

@@ -0,0 +1,226 @@
+=begin
+#ActivitySmith API
+
+#Send push notifications and Live Activities to your own devices via a single API key.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.7.0
+
+=end
+
+require 'cgi'
+
+module OpenapiClient
+  class LiveActivitiesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # End a Live Activity
+    # Ends a Live Activity and archives its lifecycle.
+    # @param live_activity_end_request [LiveActivityEndRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [LiveActivityEndResponse]
+    def end_live_activity(live_activity_end_request, opts = {})
+      data, _status_code, _headers = end_live_activity_with_http_info(live_activity_end_request, opts)
+      data
+    end
+
+    # End a Live Activity
+    # Ends a Live Activity and archives its lifecycle.
+    # @param live_activity_end_request [LiveActivityEndRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LiveActivityEndResponse, Integer, Hash)>] LiveActivityEndResponse data, response status code and response headers
+    def end_live_activity_with_http_info(live_activity_end_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LiveActivitiesApi.end_live_activity ...'
+      end
+      # verify the required parameter 'live_activity_end_request' is set
+      if @api_client.config.client_side_validation && live_activity_end_request.nil?
+        fail ArgumentError, "Missing the required parameter 'live_activity_end_request' when calling LiveActivitiesApi.end_live_activity"
+      end
+      # resource path
+      local_var_path = '/live-activity/end'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(live_activity_end_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LiveActivityEndResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"LiveActivitiesApi.end_live_activity",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LiveActivitiesApi#end_live_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Start a Live Activity
+    # Starts a Live Activity on all registered devices and returns an activity_id.
+    # @param live_activity_start_request [LiveActivityStartRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [LiveActivityStartResponse]
+    def start_live_activity(live_activity_start_request, opts = {})
+      data, _status_code, _headers = start_live_activity_with_http_info(live_activity_start_request, opts)
+      data
+    end
+
+    # Start a Live Activity
+    # Starts a Live Activity on all registered devices and returns an activity_id.
+    # @param live_activity_start_request [LiveActivityStartRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LiveActivityStartResponse, Integer, Hash)>] LiveActivityStartResponse data, response status code and response headers
+    def start_live_activity_with_http_info(live_activity_start_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LiveActivitiesApi.start_live_activity ...'
+      end
+      # verify the required parameter 'live_activity_start_request' is set
+      if @api_client.config.client_side_validation && live_activity_start_request.nil?
+        fail ArgumentError, "Missing the required parameter 'live_activity_start_request' when calling LiveActivitiesApi.start_live_activity"
+      end
+      # resource path
+      local_var_path = '/live-activity/start'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(live_activity_start_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LiveActivityStartResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"LiveActivitiesApi.start_live_activity",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LiveActivitiesApi#start_live_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a Live Activity
+    # Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued.
+    # @param live_activity_update_request [LiveActivityUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [LiveActivityUpdateResponse]
+    def update_live_activity(live_activity_update_request, opts = {})
+      data, _status_code, _headers = update_live_activity_with_http_info(live_activity_update_request, opts)
+      data
+    end
+
+    # Update a Live Activity
+    # Updates an existing Live Activity. If the per-activity token is not registered yet, the update is queued.
+    # @param live_activity_update_request [LiveActivityUpdateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LiveActivityUpdateResponse, Integer, Hash)>] LiveActivityUpdateResponse data, response status code and response headers
+    def update_live_activity_with_http_info(live_activity_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LiveActivitiesApi.update_live_activity ...'
+      end
+      # verify the required parameter 'live_activity_update_request' is set
+      if @api_client.config.client_side_validation && live_activity_update_request.nil?
+        fail ArgumentError, "Missing the required parameter 'live_activity_update_request' when calling LiveActivitiesApi.update_live_activity"
+      end
+      # resource path
+      local_var_path = '/live-activity/update'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(live_activity_update_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LiveActivityUpdateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"LiveActivitiesApi.update_live_activity",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LiveActivitiesApi#update_live_activity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/generated/activitysmith_openapi/api/push_notifications_api.rb

@@ -0,0 +1,90 @@
+=begin
+#ActivitySmith API
+
+#Send push notifications and Live Activities to your own devices via a single API key.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.7.0
+
+=end
+
+require 'cgi'
+
+module OpenapiClient
+  class PushNotificationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Send a push notification
+    # Sends a push notification to every paired device in your account.
+    # @param push_notification_request [PushNotificationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PushNotificationResponse]
+    def send_push_notification(push_notification_request, opts = {})
+      data, _status_code, _headers = send_push_notification_with_http_info(push_notification_request, opts)
+      data
+    end
+
+    # Send a push notification
+    # Sends a push notification to every paired device in your account.
+    # @param push_notification_request [PushNotificationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PushNotificationResponse, Integer, Hash)>] PushNotificationResponse data, response status code and response headers
+    def send_push_notification_with_http_info(push_notification_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PushNotificationsApi.send_push_notification ...'
+      end
+      # verify the required parameter 'push_notification_request' is set
+      if @api_client.config.client_side_validation && push_notification_request.nil?
+        fail ArgumentError, "Missing the required parameter 'push_notification_request' when calling PushNotificationsApi.send_push_notification"
+      end
+      # resource path
+      local_var_path = '/push-notification'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(push_notification_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PushNotificationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PushNotificationsApi.send_push_notification",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PushNotificationsApi#send_push_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end