ittybit 0.7.5.2 → 0.7.6

data/lib/ittybit/signatures/client.rb

@@ -16,17 +16,15 @@ module Ittybit
       @request_client = request_client
     end
 
-    # Creates a cryptographically signed URL that provides temporary and restricted
-    #  access to a file. The URL can expire after a specified time and be limited to
-    #  specific HTTP methods.
+    # You can use signatures to create signed URLs which grant access to your
+    #  project's resources, without revealing your project's API key. URLs can expire
+    #  after a specified time and be limited to HTTP `GET` method for read-only access,
+    #  or HTTP `PUT` method for client-side uploads.
     #
-    # @param filename [String] The name of the file to generate a signature for. Special characters will be
-    #  sanitised.
-    # @param folder [String] Optional folder path where the file resides. Special characters will be
-    #  sanitised.
-    # @param expiry [Long] Optional expiry time for the signature in seconds since epoch. Defaults to 60
-    #  minutes from now. Must be a positive integer and in the future.
-    # @param method [Ittybit::Signatures::SignaturesCreateRequestMethod] Optional HTTP method allowed for the signed URL. Defaults to 'get'.
+    # @param filename [String]
+    # @param folder [String]
+    # @param expiry [Integer]
+    # @param method [Ittybit::Signatures::SignaturesCreateRequestMethod]
     # @param request_options [Ittybit::RequestOptions]
     # @return [Ittybit::SignatureResponse]
     # @example
@@ -37,9 +35,9 @@ module Ittybit
     #  )
     #  api.signatures.create(
     #    filename: "video.mp4",
-    #    folder: "private/user_123",
+    #    folder: "example",
     #    expiry: 1735689600,
-    #    method: GET
+    #    method: PUT
     #  )
     def create(filename:, folder: nil, expiry: nil, method: nil, request_options: nil)
       response = @request_client.conn.post do |req|
@@ -77,17 +75,15 @@ module Ittybit
       @request_client = request_client
     end
 
-    # Creates a cryptographically signed URL that provides temporary and restricted
-    #  access to a file. The URL can expire after a specified time and be limited to
-    #  specific HTTP methods.
+    # You can use signatures to create signed URLs which grant access to your
+    #  project's resources, without revealing your project's API key. URLs can expire
+    #  after a specified time and be limited to HTTP `GET` method for read-only access,
+    #  or HTTP `PUT` method for client-side uploads.
     #
-    # @param filename [String] The name of the file to generate a signature for. Special characters will be
-    #  sanitised.
-    # @param folder [String] Optional folder path where the file resides. Special characters will be
-    #  sanitised.
-    # @param expiry [Long] Optional expiry time for the signature in seconds since epoch. Defaults to 60
-    #  minutes from now. Must be a positive integer and in the future.
-    # @param method [Ittybit::Signatures::SignaturesCreateRequestMethod] Optional HTTP method allowed for the signed URL. Defaults to 'get'.
+    # @param filename [String]
+    # @param folder [String]
+    # @param expiry [Integer]
+    # @param method [Ittybit::Signatures::SignaturesCreateRequestMethod]
     # @param request_options [Ittybit::RequestOptions]
     # @return [Ittybit::SignatureResponse]
     # @example
@@ -98,9 +94,9 @@ module Ittybit
     #  )
     #  api.signatures.create(
     #    filename: "video.mp4",
-    #    folder: "private/user_123",
+    #    folder: "example",
     #    expiry: 1735689600,
-    #    method: GET
+    #    method: PUT
     #  )
     def create(filename:, folder: nil, expiry: nil, method: nil, request_options: nil)
       Async do

data/lib/ittybit/signatures/types/signatures_create_request_method.rb

@@ -2,12 +2,9 @@
 
 module Ittybit
   class Signatures
-    # Optional HTTP method allowed for the signed URL. Defaults to 'get'.
     class SignaturesCreateRequestMethod
       GET = "get"
       PUT = "put"
-      POST = "post"
-      DELETE = "delete"
     end
   end
 end

data/lib/ittybit/types/automation.rb

@@ -9,24 +9,21 @@ require "json"
 
 module Ittybit
   class Automation
-    # @return [String] Unique identifier for the automation
+    # @return [String]
     attr_reader :id
-    # @return [String] User-defined name for the automation
+    # @return [String]
     attr_reader :name
-    # @return [String] Optional description for the automation
+    # @return [String]
     attr_reader :description
-    # @return [Hash{String => Object}] User-defined key-value metadata for the automation.
-    attr_reader :metadata
-    # @return [Ittybit::AutomationTrigger] The event and conditions that trigger this automation.
+    # @return [Ittybit::AutomationTrigger]
     attr_reader :trigger
-    # @return [Array<Ittybit::WorkflowTaskStep>] The sequence of tasks to be executed when the automation is triggered. The
-    #  structure of each task object varies depending on its 'kind'.
+    # @return [Array<Ittybit::WorkflowTaskStep>]
     attr_reader :workflow
-    # @return [Ittybit::AutomationStatus] Current status of the automation
+    # @return [Ittybit::AutomationStatus]
     attr_reader :status
-    # @return [DateTime] Timestamp when the automation was created
+    # @return [DateTime]
     attr_reader :created
-    # @return [DateTime] Timestamp when the automation was last updated
+    # @return [DateTime]
     attr_reader :updated
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -36,24 +33,21 @@ module Ittybit
 
     OMIT = Object.new
 
-    # @param id [String] Unique identifier for the automation
-    # @param name [String] User-defined name for the automation
-    # @param description [String] Optional description for the automation
-    # @param metadata [Hash{String => Object}] User-defined key-value metadata for the automation.
-    # @param trigger [Ittybit::AutomationTrigger] The event and conditions that trigger this automation.
-    # @param workflow [Array<Ittybit::WorkflowTaskStep>] The sequence of tasks to be executed when the automation is triggered. The
-    #  structure of each task object varies depending on its 'kind'.
-    # @param status [Ittybit::AutomationStatus] Current status of the automation
-    # @param created [DateTime] Timestamp when the automation was created
-    # @param updated [DateTime] Timestamp when the automation was last updated
+    # @param id [String]
+    # @param name [String]
+    # @param description [String]
+    # @param trigger [Ittybit::AutomationTrigger]
+    # @param workflow [Array<Ittybit::WorkflowTaskStep>]
+    # @param status [Ittybit::AutomationStatus]
+    # @param created [DateTime]
+    # @param updated [DateTime]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Ittybit::Automation]
-    def initialize(id:, name:, trigger:, workflow:, status:, created:, updated:, description: OMIT, metadata: OMIT,
+    def initialize(id:, name:, trigger:, workflow:, status:, created:, updated:, description: OMIT,
                    additional_properties: nil)
       @id = id
       @name = name
       @description = description if description != OMIT
-      @metadata = metadata if metadata != OMIT
       @trigger = trigger
       @workflow = workflow
       @status = status
@@ -64,7 +58,6 @@ module Ittybit
         "id": id,
         "name": name,
         "description": description,
-        "metadata": metadata,
         "trigger": trigger,
         "workflow": workflow,
         "status": status,
@@ -85,7 +78,6 @@ module Ittybit
       id = parsed_json["id"]
       name = parsed_json["name"]
       description = parsed_json["description"]
-      metadata = parsed_json["metadata"]
       if parsed_json["trigger"].nil?
         trigger = nil
       else
@@ -103,7 +95,6 @@ module Ittybit
         id: id,
         name: name,
         description: description,
-        metadata: metadata,
         trigger: trigger,
         workflow: workflow,
         status: status,
@@ -130,7 +121,6 @@ module Ittybit
       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.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
-      obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
       Ittybit::AutomationTrigger.validate_raw(obj: obj.trigger)
       obj.workflow.is_a?(Array) != false || raise("Passed value for field obj.workflow is not the expected type, validation failed.")
       obj.status.is_a?(Ittybit::AutomationStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")

data/lib/ittybit/types/automation_list_response.rb

@@ -2,6 +2,7 @@
 
 require_relative "meta_list"
 require_relative "automation"
+require_relative "error"
 require_relative "links_list"
 require "ostruct"
 require "json"
@@ -12,6 +13,8 @@ module Ittybit
     attr_reader :meta
     # @return [Array<Ittybit::Automation>]
     attr_reader :data
+    # @return [Ittybit::Error]
+    attr_reader :error
     # @return [Ittybit::LinksList]
     attr_reader :links
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -24,15 +27,17 @@ module Ittybit
 
     # @param meta [Ittybit::MetaList]
     # @param data [Array<Ittybit::Automation>]
+    # @param error [Ittybit::Error]
     # @param links [Ittybit::LinksList]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Ittybit::AutomationListResponse]
-    def initialize(meta: OMIT, data: OMIT, links: OMIT, additional_properties: nil)
+    def initialize(meta: OMIT, data: OMIT, error: OMIT, links: OMIT, additional_properties: nil)
       @meta = meta if meta != OMIT
       @data = data if data != OMIT
+      @error = error if error != OMIT
       @links = links if links != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "meta": meta, "data": data, "links": links }.reject do |_k, v|
+      @_field_set = { "meta": meta, "data": data, "error": error, "links": links }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -54,6 +59,12 @@ module Ittybit
         item = item.to_json
         Ittybit::Automation.from_json(json_object: item)
       end
+      if parsed_json["error"].nil?
+        error = nil
+      else
+        error = parsed_json["error"].to_json
+        error = Ittybit::Error.from_json(json_object: error)
+      end
       if parsed_json["links"].nil?
         links = nil
       else
@@ -63,6 +74,7 @@ module Ittybit
       new(
         meta: meta,
         data: data,
+        error: error,
         links: links,
         additional_properties: struct
       )
@@ -84,6 +96,7 @@ module Ittybit
     def self.validate_raw(obj:)
       obj.meta.nil? || Ittybit::MetaList.validate_raw(obj: obj.meta)
       obj.data&.is_a?(Array) != false || raise("Passed value for field obj.data is not the expected type, validation failed.")
+      obj.error.nil? || Ittybit::Error.validate_raw(obj: obj.error)
       obj.links.nil? || Ittybit::LinksList.validate_raw(obj: obj.links)
     end
   end

data/lib/ittybit/types/automation_response.rb

@@ -2,6 +2,7 @@
 
 require_relative "meta"
 require_relative "automation"
+require_relative "error"
 require_relative "links"
 require "ostruct"
 require "json"
@@ -12,6 +13,8 @@ module Ittybit
     attr_reader :meta
     # @return [Ittybit::Automation]
     attr_reader :data
+    # @return [Ittybit::Error]
+    attr_reader :error
     # @return [Ittybit::Links]
     attr_reader :links
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -24,15 +27,17 @@ module Ittybit
 
     # @param meta [Ittybit::META]
     # @param data [Ittybit::Automation]
+    # @param error [Ittybit::Error]
     # @param links [Ittybit::Links]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Ittybit::AutomationResponse]
-    def initialize(meta: OMIT, data: OMIT, links: OMIT, additional_properties: nil)
+    def initialize(meta: OMIT, data: OMIT, error: OMIT, links: OMIT, additional_properties: nil)
       @meta = meta if meta != OMIT
       @data = data if data != OMIT
+      @error = error if error != OMIT
       @links = links if links != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "meta": meta, "data": data, "links": links }.reject do |_k, v|
+      @_field_set = { "meta": meta, "data": data, "error": error, "links": links }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -51,6 +56,12 @@ module Ittybit
         data = parsed_json["data"].to_json
         data = Ittybit::Automation.from_json(json_object: data)
       end
+      if parsed_json["error"].nil?
+        error = nil
+      else
+        error = parsed_json["error"].to_json
+        error = Ittybit::Error.from_json(json_object: error)
+      end
       if parsed_json["links"].nil?
         links = nil
       else
@@ -60,6 +71,7 @@ module Ittybit
       new(
         meta: meta,
         data: data,
+        error: error,
         links: links,
         additional_properties: struct
       )
@@ -81,6 +93,7 @@ module Ittybit
     def self.validate_raw(obj:)
       obj.meta&.is_a?(Object) != false || raise("Passed value for field obj.meta is not the expected type, validation failed.")
       obj.data.nil? || Ittybit::Automation.validate_raw(obj: obj.data)
+      obj.error.nil? || Ittybit::Error.validate_raw(obj: obj.error)
       obj.links.nil? || Ittybit::Links.validate_raw(obj: obj.links)
     end
   end

data/lib/ittybit/types/automation_status.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Ittybit
-  # Current status of the automation
   class AutomationStatus
     ACTIVE = "active"
     INACTIVE = "inactive"

data/lib/ittybit/types/automation_trigger.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "automation_trigger_conditions_item"
 require "ostruct"
 require "json"
 
 module Ittybit
-  # The event and conditions that trigger this automation.
   class AutomationTrigger
-    # @return [String] The event that triggers the automation
+    # @return [String]
+    attr_reader :kind
+    # @return [String]
     attr_reader :event
-    # @return [Array<Ittybit::AutomationTriggerConditionsItem>] Conditions that must be met for the trigger to activate.
-    attr_reader :conditions
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -19,15 +17,15 @@ module Ittybit
 
     OMIT = Object.new
 
-    # @param event [String] The event that triggers the automation
-    # @param conditions [Array<Ittybit::AutomationTriggerConditionsItem>] Conditions that must be met for the trigger to activate.
+    # @param kind [String]
+    # @param event [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Ittybit::AutomationTrigger]
-    def initialize(event:, conditions: OMIT, additional_properties: nil)
+    def initialize(event:, kind: OMIT, additional_properties: nil)
+      @kind = kind if kind != OMIT
       @event = event
-      @conditions = conditions if conditions != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "event": event, "conditions": conditions }.reject do |_k, v|
+      @_field_set = { "kind": kind, "event": event }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -39,14 +37,11 @@ module Ittybit
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
+      kind = parsed_json["kind"]
       event = parsed_json["event"]
-      conditions = parsed_json["conditions"]&.map do |item|
-        item = item.to_json
-        Ittybit::AutomationTriggerConditionsItem.from_json(json_object: item)
-      end
       new(
+        kind: kind,
         event: event,
-        conditions: conditions,
         additional_properties: struct
       )
     end
@@ -65,8 +60,8 @@ module Ittybit
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
+      obj.kind&.is_a?(String) != false || raise("Passed value for field obj.kind is not the expected type, validation failed.")
       obj.event.is_a?(String) != false || raise("Passed value for field obj.event is not the expected type, validation failed.")
-      obj.conditions&.is_a?(Array) != false || raise("Passed value for field obj.conditions is not the expected type, validation failed.")
     end
   end
 end

data/lib/ittybit/types/{confirmation_response_data.rb → confirmation.rb}

@@ -4,7 +4,7 @@ require "ostruct"
 require "json"
 
 module Ittybit
-  class ConfirmationResponseData
+  class Confirmation
     # @return [String]
     attr_reader :message
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -17,17 +17,19 @@ module Ittybit
 
     # @param message [String]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [Ittybit::ConfirmationResponseData]
-    def initialize(message:, additional_properties: nil)
-      @message = message
+    # @return [Ittybit::Confirmation]
+    def initialize(message: OMIT, additional_properties: nil)
+      @message = message if message != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "message": message }
+      @_field_set = { "message": message }.reject do |_k, v|
+        v == OMIT
+      end
     end
 
-    # Deserialize a JSON object to an instance of ConfirmationResponseData
+    # Deserialize a JSON object to an instance of Confirmation
     #
     # @param json_object [String]
-    # @return [Ittybit::ConfirmationResponseData]
+    # @return [Ittybit::Confirmation]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
@@ -35,7 +37,7 @@ module Ittybit
       new(message: message, additional_properties: struct)
     end
 
-    # Serialize an instance of ConfirmationResponseData to a JSON object
+    # Serialize an instance of Confirmation to a JSON object
     #
     # @return [String]
     def to_json(*_args)
@@ -49,7 +51,7 @@ module Ittybit
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+      obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
     end
   end
 end

data/lib/ittybit/types/confirmation_response.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "meta"
-require_relative "confirmation_response_data"
+require_relative "confirmation"
+require_relative "error"
 require_relative "links"
 require "ostruct"
 require "json"
@@ -10,8 +11,10 @@ module Ittybit
   class ConfirmationResponse
     # @return [Ittybit::META]
     attr_reader :meta
-    # @return [Ittybit::ConfirmationResponseData]
+    # @return [Ittybit::Confirmation]
     attr_reader :data
+    # @return [Ittybit::Error]
+    attr_reader :error
     # @return [Ittybit::Links]
     attr_reader :links
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -23,16 +26,18 @@ module Ittybit
     OMIT = Object.new
 
     # @param meta [Ittybit::META]
-    # @param data [Ittybit::ConfirmationResponseData]
+    # @param data [Ittybit::Confirmation]
+    # @param error [Ittybit::Error]
     # @param links [Ittybit::Links]
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [Ittybit::ConfirmationResponse]
-    def initialize(meta: OMIT, data: OMIT, links: OMIT, additional_properties: nil)
+    def initialize(meta: OMIT, data: OMIT, error: OMIT, links: OMIT, additional_properties: nil)
       @meta = meta if meta != OMIT
       @data = data if data != OMIT
+      @error = error if error != OMIT
       @links = links if links != OMIT
       @additional_properties = additional_properties
-      @_field_set = { "meta": meta, "data": data, "links": links }.reject do |_k, v|
+      @_field_set = { "meta": meta, "data": data, "error": error, "links": links }.reject do |_k, v|
         v == OMIT
       end
     end
@@ -49,7 +54,13 @@ module Ittybit
         data = nil
       else
         data = parsed_json["data"].to_json
-        data = Ittybit::ConfirmationResponseData.from_json(json_object: data)
+        data = Ittybit::Confirmation.from_json(json_object: data)
+      end
+      if parsed_json["error"].nil?
+        error = nil
+      else
+        error = parsed_json["error"].to_json
+        error = Ittybit::Error.from_json(json_object: error)
       end
       if parsed_json["links"].nil?
         links = nil
@@ -60,6 +71,7 @@ module Ittybit
       new(
         meta: meta,
         data: data,
+        error: error,
         links: links,
         additional_properties: struct
       )
@@ -80,7 +92,8 @@ module Ittybit
     # @return [Void]
     def self.validate_raw(obj:)
       obj.meta&.is_a?(Object) != false || raise("Passed value for field obj.meta is not the expected type, validation failed.")
-      obj.data.nil? || Ittybit::ConfirmationResponseData.validate_raw(obj: obj.data)
+      obj.data.nil? || Ittybit::Confirmation.validate_raw(obj: obj.data)
+      obj.error.nil? || Ittybit::Error.validate_raw(obj: obj.error)
       obj.links.nil? || Ittybit::Links.validate_raw(obj: obj.links)
     end
   end