ittybit 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60b6f9eaf8ba438c86b11906591ad185931f0bb50617f05472350a5a5e745cc4
-  data.tar.gz: ab598d69391173fc1f981f1b0b1ee08d324c941431da6e4279e46dbfb97fe65e
+  metadata.gz: 68c5c28ca6b723ff4a4d39808a6d3abc4ed054fd989f634bbf6ad80bca79c1cc
+  data.tar.gz: 16559f00f2413da6b35e47ef14b3c55205fd2444dd93a6ec3b7aec8863149bf0
 SHA512:
-  metadata.gz: 518a4daa7c1e1fad6d2dc5d558ff870faa15842b104ca8710d457f379989e23cd5a62505d8542a1902b6d1a97df7d21500b4b8e474b839b190b530a48736ce77
-  data.tar.gz: 896025ab3aaec1237044ca7b0001127a68803ed03dba50328cd081a0c4efb5b7330c62a1d6294bd1355feb3a3bc1bf8d394d898aa48c9768c6d5f648b4dff8a7
+  metadata.gz: 9033149c63d7848dd8492b37d390fa94bf75f88cccb1599e62a0831044628f9da55f90d9f8937090336e3ae64079c87ba10a9381c1b78b4e4165063391f625ec
+  data.tar.gz: 73293534e09b68e8ff28a50c1954f235e40963ec9fe7ef236dcd0d85a4952b5a6f867343109938749153cc13af2cd3cb799a77b251b9171e4e331cee908b3a75

data/lib/ittybit/automations/client.rb

@@ -2,11 +2,13 @@
 
 require_relative "../../requests"
 require_relative "../types/automation_list_response"
+require_relative "types/automations_create_request_trigger"
+require_relative "../types/workflow_task_step"
+require_relative "types/automations_create_request_status"
 require_relative "../types/automation_response"
 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_relative "types/automations_update_request_trigger"
+require_relative "types/automations_update_request_status"
 require "async"
 
 module Ittybit
@@ -53,6 +55,16 @@ module Ittybit
 
     # Creates a new automation.
     #
+    # @param name [String]
+    # @param description [String]
+    # @param trigger [Hash] Request of type Ittybit::Automations::AutomationsCreateRequestTrigger, 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::AutomationsCreateRequestStatus]
     # @param request_options [Ittybit::RequestOptions]
     # @return [Ittybit::AutomationResponse]
     # @example
@@ -61,8 +73,14 @@ module Ittybit
     #    environment: Ittybit::Environment::DEFAULT,
     #    token: "YOUR_AUTH_TOKEN"
     #  )
-    #  api.automations.create
-    def create(request_options: nil)
+    #  api.automations.create(
+    #    name: "My Example Automation",
+    #    description: "This workflow will run whenever new media is created.",
+    #    trigger: { kind: "event", event: "media.created" },
+    #    workflow: [{ kind: DESCRIPTION }, { kind: IMAGE, ref: "thumbnail" }, { kind: CONDITIONS, next_: [{ kind: "subtitle", ref: "subtitle" }] }],
+    #    status: ACTIVE
+    #  )
+    def create(trigger:, workflow:, name: nil, description: nil, status: nil, 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?
@@ -75,9 +93,14 @@ module Ittybit
         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.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"
       end
       Ittybit::AutomationResponse.from_json(json_object: response.body)
@@ -116,36 +139,6 @@ module Ittybit
       Ittybit::AutomationResponse.from_json(json_object: response.body)
     end
 
-    # @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.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?
-        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
-
     # Permanently removes an automation from the system. This action cannot be undone.
     #
     # @param id [String]
@@ -185,14 +178,14 @@ module Ittybit
     # @param id [String]
     # @param name [String]
     # @param description [String]
-    # @param trigger [Hash] Request of type Ittybit::Automations::UpdateAutomationRequestTrigger, as a Hash
+    # @param trigger [Hash] Request of type Ittybit::Automations::AutomationsUpdateRequestTrigger, 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 status [Ittybit::Automations::AutomationsUpdateRequestStatus]
     # @param request_options [Ittybit::RequestOptions]
     # @return [Ittybit::AutomationResponse]
     # @example
@@ -201,14 +194,13 @@ module Ittybit
     #    environment: Ittybit::Environment::DEFAULT,
     #    token: "YOUR_AUTH_TOKEN"
     #  )
-    #  api.automations.update_automation(
-    #    id: "auto_abcdefgh1234",
+    #  api.automations.update(
+    #    id: "id",
     #    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)
+    def update(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?
@@ -280,6 +272,16 @@ module Ittybit
 
     # Creates a new automation.
     #
+    # @param name [String]
+    # @param description [String]
+    # @param trigger [Hash] Request of type Ittybit::Automations::AutomationsCreateRequestTrigger, 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::AutomationsCreateRequestStatus]
     # @param request_options [Ittybit::RequestOptions]
     # @return [Ittybit::AutomationResponse]
     # @example
@@ -288,8 +290,14 @@ module Ittybit
     #    environment: Ittybit::Environment::DEFAULT,
     #    token: "YOUR_AUTH_TOKEN"
     #  )
-    #  api.automations.create
-    def create(request_options: nil)
+    #  api.automations.create(
+    #    name: "My Example Automation",
+    #    description: "This workflow will run whenever new media is created.",
+    #    trigger: { kind: "event", event: "media.created" },
+    #    workflow: [{ kind: DESCRIPTION }, { kind: IMAGE, ref: "thumbnail" }, { kind: CONDITIONS, next_: [{ kind: "subtitle", ref: "subtitle" }] }],
+    #    status: ACTIVE
+    #  )
+    def create(trigger:, workflow:, name: nil, description: nil, status: nil, 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?
@@ -303,9 +311,14 @@ module Ittybit
           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.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"
         end
         Ittybit::AutomationResponse.from_json(json_object: response.body)
@@ -347,38 +360,6 @@ module Ittybit
       end
     end
 
-    # @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.update(id: "id")
-    def update(id:, request_options: nil)
-      Async do
-        @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
-          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
-
     # Permanently removes an automation from the system. This action cannot be undone.
     #
     # @param id [String]
@@ -420,14 +401,14 @@ module Ittybit
     # @param id [String]
     # @param name [String]
     # @param description [String]
-    # @param trigger [Hash] Request of type Ittybit::Automations::UpdateAutomationRequestTrigger, as a Hash
+    # @param trigger [Hash] Request of type Ittybit::Automations::AutomationsUpdateRequestTrigger, 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 status [Ittybit::Automations::AutomationsUpdateRequestStatus]
     # @param request_options [Ittybit::RequestOptions]
     # @return [Ittybit::AutomationResponse]
     # @example
@@ -436,14 +417,13 @@ module Ittybit
     #    environment: Ittybit::Environment::DEFAULT,
     #    token: "YOUR_AUTH_TOKEN"
     #  )
-    #  api.automations.update_automation(
-    #    id: "auto_abcdefgh1234",
+    #  api.automations.update(
+    #    id: "id",
     #    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)
+    def update(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?

data/lib/ittybit/automations/types/{update_automation_request_status.rb → automations_create_request_status.rb}

@@ -2,7 +2,7 @@
 
 module Ittybit
   class Automations
-    class UpdateAutomationRequestStatus
+    class AutomationsCreateRequestStatus
       ACTIVE = "active"
       PAUSED = "paused"
     end

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

@@ -5,7 +5,7 @@ require "json"
 
 module Ittybit
   class Automations
-    class UpdateAutomationRequestTrigger
+    class AutomationsCreateRequestTrigger
       # @return [String]
       attr_reader :kind
       # @return [String]
@@ -21,7 +21,7 @@ module Ittybit
       # @param kind [String]
       # @param event [String]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Ittybit::Automations::UpdateAutomationRequestTrigger]
+      # @return [Ittybit::Automations::AutomationsCreateRequestTrigger]
       def initialize(kind:, event:, additional_properties: nil)
         @kind = kind
         @event = event
@@ -29,10 +29,10 @@ module Ittybit
         @_field_set = { "kind": kind, "event": event }
       end
 
-      # Deserialize a JSON object to an instance of UpdateAutomationRequestTrigger
+      # Deserialize a JSON object to an instance of AutomationsCreateRequestTrigger
       #
       # @param json_object [String]
-      # @return [Ittybit::Automations::UpdateAutomationRequestTrigger]
+      # @return [Ittybit::Automations::AutomationsCreateRequestTrigger]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
@@ -45,7 +45,7 @@ module Ittybit
         )
       end
 
-      # Serialize an instance of UpdateAutomationRequestTrigger to a JSON object
+      # Serialize an instance of AutomationsCreateRequestTrigger to a JSON object
       #
       # @return [String]
       def to_json(*_args)

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

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

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Automations
+    class AutomationsUpdateRequestTrigger
+      # @return [String]
+      attr_reader :kind
+      # @return [String]
+      attr_reader :event
+      # @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 kind [String]
+      # @param event [String]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Ittybit::Automations::AutomationsUpdateRequestTrigger]
+      def initialize(kind:, event:, additional_properties: nil)
+        @kind = kind
+        @event = event
+        @additional_properties = additional_properties
+        @_field_set = { "kind": kind, "event": event }
+      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)
+        kind = parsed_json["kind"]
+        event = parsed_json["event"]
+        new(
+          kind: kind,
+          event: event,
+          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.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
+end

data/lib/requests.rb

@@ -46,7 +46,7 @@ module Ittybit
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "ittybit", "X-Fern-SDK-Version": "0.8.0" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "ittybit", "X-Fern-SDK-Version": "0.8.2" }
       headers["Authorization"] = ((@token.is_a? Method) ? @token.call : @token) unless @token.nil?
       headers
     end
@@ -93,7 +93,7 @@ module Ittybit
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "ittybit", "X-Fern-SDK-Version": "0.8.0" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "ittybit", "X-Fern-SDK-Version": "0.8.2" }
       headers["Authorization"] = ((@token.is_a? Method) ? @token.call : @token) unless @token.nil?
       headers
     end

data/lib/types_export.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require_relative "ittybit/automations/types/update_automation_request_trigger"
-require_relative "ittybit/automations/types/update_automation_request_status"
+require_relative "ittybit/automations/types/automations_create_request_trigger"
+require_relative "ittybit/automations/types/automations_create_request_status"
+require_relative "ittybit/automations/types/automations_update_request_trigger"
+require_relative "ittybit/automations/types/automations_update_request_status"
 require_relative "ittybit/signatures/types/signatures_create_request_method"
 require_relative "ittybit/types/meta"
 require_relative "ittybit/types/meta_list_type"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ittybit
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - ''
@@ -100,8 +100,10 @@ files:
 - lib/gemconfig.rb
 - lib/ittybit.rb
 - lib/ittybit/automations/client.rb
-- lib/ittybit/automations/types/update_automation_request_status.rb
-- lib/ittybit/automations/types/update_automation_request_trigger.rb
+- lib/ittybit/automations/types/automations_create_request_status.rb
+- lib/ittybit/automations/types/automations_create_request_trigger.rb
+- lib/ittybit/automations/types/automations_update_request_status.rb
+- lib/ittybit/automations/types/automations_update_request_trigger.rb
 - lib/ittybit/files/client.rb
 - lib/ittybit/media/client.rb
 - lib/ittybit/signatures/client.rb