ittybit 0.7.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd4edbf83cbc903e9c7eab679092dbd12a65e76d8152d609b51dabdfb3cfac41
+  data.tar.gz: bb868b0c7df908594b7be7b1bf6fc7f2cd314eca2e742dde6fb9bbee5416b3d7
+SHA512:
+  metadata.gz: 061a275e494adcbf1dddc980e80b39f2c12a6a21b0752f4570d6c26e781f7b9d449b4fcca358e85b3cac3a081c6d4c72b8cc9349fa1b99b45a73adaea6a9cd10
+  data.tar.gz: 466a55677227ab52622ac2a425ceda3bffe0f9c07233a334e0d7b8678d6e9aa88523b4042c1d68de444a31bd555a638af11898bc2c9aa346d45d00e1e66d08fe

data/lib/environment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ittybit
+  class Environment
+    DEFAULT = "https://api.ittybit.com"
+  end
+end

data/lib/gemconfig.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Ittybit
+  module Gemconfig
+    VERSION = ""
+    AUTHORS = [""].freeze
+    EMAIL = ""
+    SUMMARY = ""
+    DESCRIPTION = ""
+    HOMEPAGE = "https://github.com/ittybit/sdk-ruby"
+    SOURCE_CODE_URI = "https://github.com/ittybit/sdk-ruby"
+    CHANGELOG_URI = "https://github.com/ittybit/sdk-ruby/blob/master/CHANGELOG.md"
+  end
+end

data/lib/ittybit/automations/client.rb

@@ -0,0 +1,412 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/automation_list_response"
+require_relative "../types/automation_response"
+require_relative "types/automations_update_request_trigger"
+require_relative "../types/workflow_task_step"
+require "async"
+
+module Ittybit
+  class AutomationsClient
+    # @return [Ittybit::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Ittybit::RequestClient]
+    # @return [Ittybit::AutomationsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Retrieves a list of all automations for the current project
+    #
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::AutomationListResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.automations.list
+    def list(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?
+        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
+        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"
+      end
+      Ittybit::AutomationListResponse.from_json(json_object: response.body)
+    end
+
+    # Creates a new automation for the current project
+    #
+    # @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.create
+    def create(request_options: nil)
+      response = @request_client.conn.post 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
+        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"
+      end
+      Ittybit::AutomationResponse.from_json(json_object: response.body)
+    end
+
+    # Retrieves a specific automation by its ID
+    #
+    # @param id [String]
+    # @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.get(id: "id")
+    def get(id:, 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?
+        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
+        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
+
+    # 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)
+    #   * :label (String)
+    #   * :format (String)
+    #   * :width (Integer)
+    #   * :height (Integer)
+    #   * :resize (String)
+    #   * :quality (Integer)
+    # @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(
+    #    id: "id",
+    #    name: "Updated Transcoder Example",
+    #    trigger: { event: "upload.completed", conditions: [{ prop: "file.type", value: "image/*" }] },
+    #    workflow: [{ kind: IMAGE, label: "archive_image", format: "webp" }]
+    #  )
+    def update(id:, name:, description: nil, trigger: nil, workflow: nil, request_options: nil)
+      response = @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?
+        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
+        }.compact
+        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
+    #
+    # @param id [String]
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Void]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.automations.delete(id: "id")
+    def delete(id:, request_options: nil)
+      @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?
+        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
+        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
+    end
+  end
+
+  class AsyncAutomationsClient
+    # @return [Ittybit::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [Ittybit::AsyncRequestClient]
+    # @return [Ittybit::AsyncAutomationsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Retrieves a list of all automations for the current project
+    #
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Ittybit::AutomationListResponse]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.automations.list
+    def list(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?
+          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
+          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"
+        end
+        Ittybit::AutomationListResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Creates a new automation for the current project
+    #
+    # @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.create
+    def create(request_options: nil)
+      Async do
+        response = @request_client.conn.post 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
+          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"
+        end
+        Ittybit::AutomationResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Retrieves a specific automation by its ID
+    #
+    # @param id [String]
+    # @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.get(id: "id")
+    def get(id:, 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?
+          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
+          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
+
+    # 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)
+    #   * :label (String)
+    #   * :format (String)
+    #   * :width (Integer)
+    #   * :height (Integer)
+    #   * :resize (String)
+    #   * :quality (Integer)
+    # @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(
+    #    id: "id",
+    #    name: "Updated Transcoder Example",
+    #    trigger: { event: "upload.completed", conditions: [{ prop: "file.type", value: "image/*" }] },
+    #    workflow: [{ kind: IMAGE, label: "archive_image", format: "webp" }]
+    #  )
+    def update(id:, name:, description: nil, trigger: nil, workflow: nil, request_options: nil)
+      Async do
+        response = @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?
+          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
+          }.compact
+          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
+    #
+    # @param id [String]
+    # @param request_options [Ittybit::RequestOptions]
+    # @return [Void]
+    # @example
+    #  api = Ittybit::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: Ittybit::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.automations.delete(id: "id")
+    def delete(id:, request_options: nil)
+      Async do
+        @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?
+          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
+          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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "automations_update_request_trigger_conditions_item"
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Automations
+    # Defines the trigger event and conditions. To clear/remove a trigger, provide
+    #  null. To update, provide the new trigger object.
+    class AutomationsUpdateRequestTrigger
+      # @return [String] The event that triggers the automation
+      attr_reader :event
+      # @return [Array<Ittybit::Automations::AutomationsUpdateRequestTriggerConditionsItem>] 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]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param event [String] The event that triggers the automation
+      # @param conditions [Array<Ittybit::Automations::AutomationsUpdateRequestTriggerConditionsItem>] Conditions that must be met for the trigger to activate.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Ittybit::Automations::AutomationsUpdateRequestTrigger]
+      def initialize(event: OMIT, conditions: OMIT, additional_properties: nil)
+        @event = event if event != OMIT
+        @conditions = conditions if conditions != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "event": event, "conditions": conditions }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of AutomationsUpdateRequestTrigger
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Automations::AutomationsUpdateRequestTrigger]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        event = parsed_json["event"]
+        conditions = parsed_json["conditions"]&.map do |item|
+          item = item.to_json
+          Ittybit::Automations::AutomationsUpdateRequestTriggerConditionsItem.from_json(json_object: item)
+        end
+        new(
+          event: event,
+          conditions: conditions,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AutomationsUpdateRequestTrigger to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        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
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Automations
+    class AutomationsUpdateRequestTriggerConditionsItem
+      # @return [String]
+      attr_reader :prop
+      # @return [String]
+      attr_reader :value
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param prop [String]
+      # @param value [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
+        @additional_properties = additional_properties
+        @_field_set = { "prop": prop, "value": value }
+      end
+
+      # Deserialize a JSON object to an instance of
+      #  AutomationsUpdateRequestTriggerConditionsItem
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Automations::AutomationsUpdateRequestTriggerConditionsItem]
+      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"]
+        new(
+          prop: prop,
+          value: value,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AutomationsUpdateRequestTriggerConditionsItem to a JSON
+      #  object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @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.")
+      end
+    end
+  end
+end