ittybit 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b244efadc944c3d3983943a53e62e0b553e21eb9e0717ff4a3ee1512f3879909
-  data.tar.gz: f3736a908e119ee1324f616e07af8f63e4fdd5f0ac4447b6440990ece8fd7629
+  metadata.gz: 60b6f9eaf8ba438c86b11906591ad185931f0bb50617f05472350a5a5e745cc4
+  data.tar.gz: ab598d69391173fc1f981f1b0b1ee08d324c941431da6e4279e46dbfb97fe65e
 SHA512:
-  metadata.gz: 50e7da1d6cfb20932674642060b296ac71aedc88cb7ff4fa821ce18775458168afb227792f3605b601dccd370b15943e136ddd7f2fed98fe70a900ead5b1215c
-  data.tar.gz: c3038600b9d3973c045e1a7efa2e789bb15ba17b3ea3e5cab7b7681798634eb7d5c4c9b822d417599c6e034ed8a5e28affa1c29ee3779974ec45c8f48720b097
+  metadata.gz: 518a4daa7c1e1fad6d2dc5d558ff870faa15842b104ca8710d457f379989e23cd5a62505d8542a1902b6d1a97df7d21500b4b8e474b839b190b530a48736ce77
+  data.tar.gz: 896025ab3aaec1237044ca7b0001127a68803ed03dba50328cd081a0c4efb5b7330c62a1d6294bd1355feb3a3bc1bf8d394d898aa48c9768c6d5f648b4dff8a7

data/lib/ittybit/automations/client.rb

@@ -3,8 +3,10 @@
 require_relative "../../requests"
 require_relative "../types/automation_list_response"
 require_relative "../types/automation_response"
-require_relative "types/automations_update_request_trigger"
+require_relative "../types/confirmation_response"
+require_relative "types/update_automation_request_trigger"
 require_relative "../types/workflow_task_step"
+require_relative "types/update_automation_request_status"
 require "async"
 
 module Ittybit
@@ -18,8 +20,9 @@ module Ittybit
       @request_client = request_client
     end
 
-    # Retrieves a list of all automations for the current project
+    # Retrieves a paginated list of all automations for the current project
     #
+    # @param limit [Integer]
     # @param request_options [Ittybit::RequestOptions]
     # @return [Ittybit::AutomationListResponse]
     # @example
@@ -29,7 +32,7 @@ module Ittybit
     #    token: "YOUR_AUTH_TOKEN"
     #  )
     #  api.automations.list
-    def list(request_options: nil)
+    def list(limit: nil, request_options: nil)
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -39,9 +42,7 @@ module Ittybit
       **@request_client.get_headers,
       **(request_options&.additional_headers || {})
         }.compact
-        unless request_options.nil? || request_options&.additional_query_parameters.nil?
-          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-        end
+        req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit }.compact
         unless request_options.nil? || request_options&.additional_body_parameters.nil?
           req.body = { **(request_options&.additional_body_parameters || {}) }.compact
         end
@@ -50,7 +51,7 @@ module Ittybit
       Ittybit::AutomationListResponse.from_json(json_object: response.body)
     end
 
-    # Creates a new automation for the current project
+    # Creates a new automation.
     #
     # @param request_options [Ittybit::RequestOptions]
     # @return [Ittybit::AutomationResponse]
@@ -82,7 +83,7 @@ module Ittybit
       Ittybit::AutomationResponse.from_json(json_object: response.body)
     end
 
-    # Retrieves a specific automation by its ID
+    # Retrieve the automation object for a automation with the given ID.
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
@@ -115,43 +116,18 @@ module Ittybit
       Ittybit::AutomationResponse.from_json(json_object: response.body)
     end
 
-    # Updates an existing automation by its ID
-    #
     # @param id [String]
-    # @param name [String]
-    # @param description [String]
-    # @param trigger [Hash] Defines the trigger event and conditions. To clear/remove a trigger, provide
-    #  null. To update, provide the new trigger object.Request of type Ittybit::Automations::AutomationsUpdateRequestTrigger, as a Hash
-    #   * :event (String)
-    #   * :conditions (Array<Ittybit::Automations::AutomationsUpdateRequestTriggerConditionsItem>)
-    # @param workflow [Array<Hash>] The updated sequence of tasks for the automation.Request of type Array<Ittybit::WorkflowTaskStep>, as a Hash
-    #   * :kind (Ittybit::WorkflowTaskStepKind)
-    #   * :ref (String)
-    #   * :format (String)
-    #   * :start (Float)
-    #   * :end_ (Float)
-    #   * :width (Integer)
-    #   * :height (Integer)
-    #   * :fit (String)
-    #   * :background (String)
-    #   * :quality (Integer)
-    #   * :next_ (Array<Object>)
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::AutomationResponse]
+    # @return [Void]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
     #    token: "YOUR_AUTH_TOKEN"
     #  )
-    #  api.automations.update(
-    #    id: "id",
-    #    name: "Updated Transcoder Example",
-    #    trigger: { event: "upload.completed", conditions: [{ prop: "file.type", value: "image/*" }] },
-    #    workflow: [{ kind: IMAGE, format: "webp" }]
-    #  )
-    def update(id:, name:, description: nil, trigger: nil, workflow: nil, request_options: nil)
-      response = @request_client.conn.put do |req|
+    #  api.automations.update(id: "id")
+    def update(id:, request_options: nil)
+      @request_client.conn.put do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
@@ -163,23 +139,18 @@ module Ittybit
         unless request_options.nil? || request_options&.additional_query_parameters.nil?
           req.params = { **(request_options&.additional_query_parameters || {}) }.compact
         end
-        req.body = {
-          **(request_options&.additional_body_parameters || {}),
-          name: name,
-          description: description,
-          trigger: trigger,
-          workflow: workflow
-        }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
         req.url "#{@request_client.get_url(request_options: request_options)}/automations/#{id}"
       end
-      Ittybit::AutomationResponse.from_json(json_object: response.body)
     end
 
-    # Deletes an automation by its ID
+    # Permanently removes an automation from the system. This action cannot be undone.
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Void]
+    # @return [Ittybit::ConfirmationResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -188,7 +159,7 @@ module Ittybit
     #  )
     #  api.automations.delete(id: "id")
     def delete(id:, request_options: nil)
-      @request_client.conn.delete do |req|
+      response = @request_client.conn.delete do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
@@ -205,6 +176,62 @@ module Ittybit
         end
         req.url "#{@request_client.get_url(request_options: request_options)}/automations/#{id}"
       end
+      Ittybit::ConfirmationResponse.from_json(json_object: response.body)
+    end
+
+    # Updates an automation's `name`, `description`, `trigger`, `workflow`, or
+    #  `status`. Only the specified fields will be updated.
+    #
+    # @param id [String]
+    # @param name [String]
+    # @param description [String]
+    # @param trigger [Hash] Request of type Ittybit::Automations::UpdateAutomationRequestTrigger, as a Hash
+    #   * :kind (String)
+    #   * :event (String)
+    # @param workflow [Array<Hash>] Request of type Array<Ittybit::WorkflowTaskStep>, as a Hash
+    #   * :kind (Ittybit::WorkflowTaskStepKind)
+    #   * :ref (String)
+    #   * :next_ (Array<Ittybit::WorkflowTaskStepNextItem>)
+    # @param status [Ittybit::Automations::UpdateAutomationRequestStatus]
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::AutomationResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.automations.update_automation(
+    #    id: "auto_abcdefgh1234",
+    #    name: "My Updated Automation",
+    #    workflow: [{ kind: NSFW }, { kind: DESCRIPTION }, { kind: IMAGE, ref: "big_thumbnail" }, { kind: CONDITIONS, next_: [{ kind: "subtitle", ref: "subtitle" }] }],
+    #    status: ACTIVE
+    #  )
+    def update_automation(id:, name: nil, description: nil, trigger: nil, workflow: nil, status: nil,
+                          request_options: nil)
+      response = @request_client.conn.patch do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        req.body = {
+          **(request_options&.additional_body_parameters || {}),
+          name: name,
+          description: description,
+          trigger: trigger,
+          workflow: workflow,
+          status: status
+        }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/automations/#{id}"
+      end
+      Ittybit::AutomationResponse.from_json(json_object: response.body)
     end
   end
 
@@ -218,8 +245,9 @@ module Ittybit
       @request_client = request_client
     end
 
-    # Retrieves a list of all automations for the current project
+    # Retrieves a paginated list of all automations for the current project
     #
+    # @param limit [Integer]
     # @param request_options [Ittybit::RequestOptions]
     # @return [Ittybit::AutomationListResponse]
     # @example
@@ -229,7 +257,7 @@ module Ittybit
     #    token: "YOUR_AUTH_TOKEN"
     #  )
     #  api.automations.list
-    def list(request_options: nil)
+    def list(limit: nil, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -240,9 +268,7 @@ module Ittybit
         **@request_client.get_headers,
         **(request_options&.additional_headers || {})
           }.compact
-          unless request_options.nil? || request_options&.additional_query_parameters.nil?
-            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-          end
+          req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
           end
@@ -252,7 +278,7 @@ module Ittybit
       end
     end
 
-    # Creates a new automation for the current project
+    # Creates a new automation.
     #
     # @param request_options [Ittybit::RequestOptions]
     # @return [Ittybit::AutomationResponse]
@@ -286,7 +312,7 @@ module Ittybit
       end
     end
 
-    # Retrieves a specific automation by its ID
+    # Retrieve the automation object for a automation with the given ID.
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
@@ -321,44 +347,19 @@ module Ittybit
       end
     end
 
-    # Updates an existing automation by its ID
-    #
     # @param id [String]
-    # @param name [String]
-    # @param description [String]
-    # @param trigger [Hash] Defines the trigger event and conditions. To clear/remove a trigger, provide
-    #  null. To update, provide the new trigger object.Request of type Ittybit::Automations::AutomationsUpdateRequestTrigger, as a Hash
-    #   * :event (String)
-    #   * :conditions (Array<Ittybit::Automations::AutomationsUpdateRequestTriggerConditionsItem>)
-    # @param workflow [Array<Hash>] The updated sequence of tasks for the automation.Request of type Array<Ittybit::WorkflowTaskStep>, as a Hash
-    #   * :kind (Ittybit::WorkflowTaskStepKind)
-    #   * :ref (String)
-    #   * :format (String)
-    #   * :start (Float)
-    #   * :end_ (Float)
-    #   * :width (Integer)
-    #   * :height (Integer)
-    #   * :fit (String)
-    #   * :background (String)
-    #   * :quality (Integer)
-    #   * :next_ (Array<Object>)
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::AutomationResponse]
+    # @return [Void]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
     #    token: "YOUR_AUTH_TOKEN"
     #  )
-    #  api.automations.update(
-    #    id: "id",
-    #    name: "Updated Transcoder Example",
-    #    trigger: { event: "upload.completed", conditions: [{ prop: "file.type", value: "image/*" }] },
-    #    workflow: [{ kind: IMAGE, format: "webp" }]
-    #  )
-    def update(id:, name:, description: nil, trigger: nil, workflow: nil, request_options: nil)
+    #  api.automations.update(id: "id")
+    def update(id:, request_options: nil)
       Async do
-        response = @request_client.conn.put do |req|
+        @request_client.conn.put do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
@@ -370,24 +371,19 @@ module Ittybit
           unless request_options.nil? || request_options&.additional_query_parameters.nil?
             req.params = { **(request_options&.additional_query_parameters || {}) }.compact
           end
-          req.body = {
-            **(request_options&.additional_body_parameters || {}),
-            name: name,
-            description: description,
-            trigger: trigger,
-            workflow: workflow
-          }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
           req.url "#{@request_client.get_url(request_options: request_options)}/automations/#{id}"
         end
-        Ittybit::AutomationResponse.from_json(json_object: response.body)
       end
     end
 
-    # Deletes an automation by its ID
+    # Permanently removes an automation from the system. This action cannot be undone.
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Void]
+    # @return [Ittybit::ConfirmationResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
@@ -397,7 +393,7 @@ module Ittybit
     #  api.automations.delete(id: "id")
     def delete(id:, request_options: nil)
       Async do
-        @request_client.conn.delete do |req|
+        response = @request_client.conn.delete do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
@@ -414,6 +410,64 @@ module Ittybit
           end
           req.url "#{@request_client.get_url(request_options: request_options)}/automations/#{id}"
         end
+        Ittybit::ConfirmationResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Updates an automation's `name`, `description`, `trigger`, `workflow`, or
+    #  `status`. Only the specified fields will be updated.
+    #
+    # @param id [String]
+    # @param name [String]
+    # @param description [String]
+    # @param trigger [Hash] Request of type Ittybit::Automations::UpdateAutomationRequestTrigger, as a Hash
+    #   * :kind (String)
+    #   * :event (String)
+    # @param workflow [Array<Hash>] Request of type Array<Ittybit::WorkflowTaskStep>, as a Hash
+    #   * :kind (Ittybit::WorkflowTaskStepKind)
+    #   * :ref (String)
+    #   * :next_ (Array<Ittybit::WorkflowTaskStepNextItem>)
+    # @param status [Ittybit::Automations::UpdateAutomationRequestStatus]
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::AutomationResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.automations.update_automation(
+    #    id: "auto_abcdefgh1234",
+    #    name: "My Updated Automation",
+    #    workflow: [{ kind: NSFW }, { kind: DESCRIPTION }, { kind: IMAGE, ref: "big_thumbnail" }, { kind: CONDITIONS, next_: [{ kind: "subtitle", ref: "subtitle" }] }],
+    #    status: ACTIVE
+    #  )
+    def update_automation(id:, name: nil, description: nil, trigger: nil, workflow: nil, status: nil,
+                          request_options: nil)
+      Async do
+        response = @request_client.conn.patch do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = {
+            **(request_options&.additional_body_parameters || {}),
+            name: name,
+            description: description,
+            trigger: trigger,
+            workflow: workflow,
+            status: status
+          }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/automations/#{id}"
+        end
+        Ittybit::AutomationResponse.from_json(json_object: response.body)
       end
     end
   end

data/lib/ittybit/automations/types/update_automation_request_status.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Ittybit
+  class Automations
+    class UpdateAutomationRequestStatus
+      ACTIVE = "active"
+      PAUSED = "paused"
+    end
+  end
+end

data/lib/ittybit/automations/types/{automations_update_request_trigger_conditions_item.rb → update_automation_request_trigger.rb}

@@ -5,11 +5,11 @@ require "json"
 
 module Ittybit
   class Automations
-    class AutomationsUpdateRequestTriggerConditionsItem
+    class UpdateAutomationRequestTrigger
       # @return [String]
-      attr_reader :prop
+      attr_reader :kind
       # @return [String]
-      attr_reader :value
+      attr_reader :event
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -18,36 +18,34 @@ module Ittybit
 
       OMIT = Object.new
 
-      # @param prop [String]
-      # @param value [String]
+      # @param kind [String]
+      # @param event [String]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Ittybit::Automations::AutomationsUpdateRequestTriggerConditionsItem]
-      def initialize(prop:, value:, additional_properties: nil)
-        @prop = prop
-        @value = value
+      # @return [Ittybit::Automations::UpdateAutomationRequestTrigger]
+      def initialize(kind:, event:, additional_properties: nil)
+        @kind = kind
+        @event = event
         @additional_properties = additional_properties
-        @_field_set = { "prop": prop, "value": value }
+        @_field_set = { "kind": kind, "event": event }
       end
 
-      # Deserialize a JSON object to an instance of
-      #  AutomationsUpdateRequestTriggerConditionsItem
+      # Deserialize a JSON object to an instance of UpdateAutomationRequestTrigger
       #
       # @param json_object [String]
-      # @return [Ittybit::Automations::AutomationsUpdateRequestTriggerConditionsItem]
+      # @return [Ittybit::Automations::UpdateAutomationRequestTrigger]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        prop = parsed_json["prop"]
-        value = parsed_json["value"]
+        kind = parsed_json["kind"]
+        event = parsed_json["event"]
         new(
-          prop: prop,
-          value: value,
+          kind: kind,
+          event: event,
           additional_properties: struct
         )
       end
 
-      # Serialize an instance of AutomationsUpdateRequestTriggerConditionsItem to a JSON
-      #  object
+      # Serialize an instance of UpdateAutomationRequestTrigger to a JSON object
       #
       # @return [String]
       def to_json(*_args)
@@ -61,8 +59,8 @@ module Ittybit
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.prop.is_a?(String) != false || raise("Passed value for field obj.prop is not the expected type, validation failed.")
-        obj.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+        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.")
       end
     end
   end

data/lib/ittybit/media/client.rb

@@ -48,7 +48,7 @@ module Ittybit
       Ittybit::MediaListResponse.from_json(json_object: response.body)
     end
 
-    # Creates a new media item.
+    # Creates a new media item. See [Media Object](/docs/media) for more details.
     #
     # @param title [String]
     # @param alt [String]
@@ -246,7 +246,7 @@ module Ittybit
       end
     end
 
-    # Creates a new media item.
+    # Creates a new media item. See [Media Object](/docs/media) for more details.
     #
     # @param title [String]
     # @param alt [String]