ittybit 0.8.7 → 0.9.0

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Automations
+    class AutomationsUpdateResponseError
+      # @return [String]
+      attr_reader :message
+      # @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 message [String]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Ittybit::Automations::AutomationsUpdateResponseError]
+      def initialize(message: OMIT, additional_properties: nil)
+        @message = message if message != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "message": message }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of AutomationsUpdateResponseError
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Automations::AutomationsUpdateResponseError]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        message = parsed_json["message"]
+        new(message: message, additional_properties: struct)
+      end
+
+      # Serialize an instance of AutomationsUpdateResponseError 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.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Automations
+    class AutomationsUpdateResponseLinks
+      # @return [String]
+      attr_reader :self_
+      # @return [String]
+      attr_reader :parent
+      # @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 self_ [String]
+      # @param parent [String]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Ittybit::Automations::AutomationsUpdateResponseLinks]
+      def initialize(self_: OMIT, parent: OMIT, additional_properties: nil)
+        @self_ = self_ if self_ != OMIT
+        @parent = parent if parent != OMIT
+        @additional_properties = additional_properties
+        @_field_set = { "self": self_, "parent": parent }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of AutomationsUpdateResponseLinks
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Automations::AutomationsUpdateResponseLinks]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        self_ = parsed_json["self"]
+        parent = parsed_json["parent"]
+        new(
+          self_: self_,
+          parent: parent,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AutomationsUpdateResponseLinks 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.self_&.is_a?(String) != false || raise("Passed value for field obj.self_ is not the expected type, validation failed.")
+        obj.parent&.is_a?(String) != false || raise("Passed value for field obj.parent is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative "automations_update_response_meta_type"
+require "ostruct"
+require "json"
+
+module Ittybit
+  class Automations
+    class AutomationsUpdateResponseMeta
+      # @return [String]
+      attr_reader :request_id
+      # @return [String]
+      attr_reader :org_id
+      # @return [String]
+      attr_reader :project_id
+      # @return [String]
+      attr_reader :version
+      # @return [Ittybit::Automations::AutomationsUpdateResponseMetaType]
+      attr_reader :type
+      # @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 request_id [String]
+      # @param org_id [String]
+      # @param project_id [String]
+      # @param version [String]
+      # @param type [Ittybit::Automations::AutomationsUpdateResponseMetaType]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Ittybit::Automations::AutomationsUpdateResponseMeta]
+      def initialize(request_id: OMIT, org_id: OMIT, project_id: OMIT, version: OMIT, type: OMIT,
+                     additional_properties: nil)
+        @request_id = request_id if request_id != OMIT
+        @org_id = org_id if org_id != OMIT
+        @project_id = project_id if project_id != OMIT
+        @version = version if version != OMIT
+        @type = type if type != OMIT
+        @additional_properties = additional_properties
+        @_field_set = {
+          "request_id": request_id,
+          "org_id": org_id,
+          "project_id": project_id,
+          "version": version,
+          "type": type
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of AutomationsUpdateResponseMeta
+      #
+      # @param json_object [String]
+      # @return [Ittybit::Automations::AutomationsUpdateResponseMeta]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        request_id = parsed_json["request_id"]
+        org_id = parsed_json["org_id"]
+        project_id = parsed_json["project_id"]
+        version = parsed_json["version"]
+        type = parsed_json["type"]
+        new(
+          request_id: request_id,
+          org_id: org_id,
+          project_id: project_id,
+          version: version,
+          type: type,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of AutomationsUpdateResponseMeta 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.request_id&.is_a?(String) != false || raise("Passed value for field obj.request_id is not the expected type, validation failed.")
+        obj.org_id&.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
+        obj.project_id&.is_a?(String) != false || raise("Passed value for field obj.project_id is not the expected type, validation failed.")
+        obj.version&.is_a?(String) != false || raise("Passed value for field obj.version is not the expected type, validation failed.")
+        obj.type&.is_a?(Ittybit::Automations::AutomationsUpdateResponseMetaType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Ittybit
+  class Automations
+    class AutomationsUpdateResponseMetaType
+      OBJECT = "object"
+      LIST = "list"
+    end
+  end
+end

data/lib/ittybit/files/client.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
-require_relative "../types/file_list_response"
-require_relative "../types/file_response"
-require_relative "../types/confirmation_response"
+require_relative "types/files_list_response"
+require_relative "types/files_create_response"
+require_relative "types/files_get_response"
+require_relative "types/files_delete_response"
+require_relative "types/files_update_response"
 require "async"
 
 module Ittybit
@@ -22,18 +24,18 @@ module Ittybit
     # @param page [Integer]
     # @param limit [Integer]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::FileListResponse]
+    # @return [Ittybit::Files::FilesListResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.files.list
     def list(page: nil, 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?
+        req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
       **(req.headers || {}),
@@ -46,7 +48,7 @@ module Ittybit
         end
         req.url "#{@request_client.get_url(request_options: request_options)}/files"
       end
-      Ittybit::FileListResponse.from_json(json_object: response.body)
+      Ittybit::Files::FilesListResponse.from_json(json_object: response.body)
     end
 
     # Creates a new file from a publicly accessible or signed URL.
@@ -58,23 +60,23 @@ module Ittybit
     # @param ref [String]
     # @param metadata [Hash{String => Object}]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::FileResponse]
+    # @return [Ittybit::Files::FilesCreateResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.files.create(
     #    url: "https://ittyb.it/sample.mp4",
     #    folder: "ittybit/samples",
     #    filename: "video.mp4",
-    #    metadata: { "customKey2": "a different custom value" }
+    #    metadata: { "customKey": "your custom value" }
     #  )
     def create(url:, media_id: nil, folder: nil, filename: nil, ref: nil, metadata: 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?
+        req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
       **(req.headers || {}),
@@ -95,25 +97,25 @@ module Ittybit
         }.compact
         req.url "#{@request_client.get_url(request_options: request_options)}/files"
       end
-      Ittybit::FileResponse.from_json(json_object: response.body)
+      Ittybit::Files::FilesCreateResponse.from_json(json_object: response.body)
     end
 
     # Retrieve the file object for a file with the given ID.
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::FileResponse]
+    # @return [Ittybit::Files::FilesGetResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.files.get(id: "file_abcdefgh1234")
     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["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
       **(req.headers || {}),
@@ -128,25 +130,25 @@ module Ittybit
         end
         req.url "#{@request_client.get_url(request_options: request_options)}/files/#{id}"
       end
-      Ittybit::FileResponse.from_json(json_object: response.body)
+      Ittybit::Files::FilesGetResponse.from_json(json_object: response.body)
     end
 
     # Permanently removes a file from the system. This action cannot be undone.
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::ConfirmationResponse]
+    # @return [Ittybit::Files::FilesDeleteResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.files.delete(id: "file_abcdefgh1234")
     def delete(id:, request_options: nil)
       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["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
       **(req.headers || {}),
@@ -161,7 +163,7 @@ module Ittybit
         end
         req.url "#{@request_client.get_url(request_options: request_options)}/files/#{id}"
       end
-      Ittybit::ConfirmationResponse.from_json(json_object: response.body)
+      Ittybit::Files::FilesDeleteResponse.from_json(json_object: response.body)
     end
 
     # Update a file's `filename`, `folder`, `ref`, or `metadata`. Only the specified
@@ -173,12 +175,12 @@ module Ittybit
     # @param ref [String]
     # @param metadata [Hash{String => Object}]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::FileResponse]
+    # @return [Ittybit::Files::FilesUpdateResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.files.update(
     #    id: "file_abcdefgh1234",
@@ -189,7 +191,7 @@ module Ittybit
     def update(id:, folder: nil, filename: nil, ref: nil, metadata: 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["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
         req.headers = {
       **(req.headers || {}),
@@ -208,7 +210,7 @@ module Ittybit
         }.compact
         req.url "#{@request_client.get_url(request_options: request_options)}/files/#{id}"
       end
-      Ittybit::FileResponse.from_json(json_object: response.body)
+      Ittybit::Files::FilesUpdateResponse.from_json(json_object: response.body)
     end
   end
 
@@ -227,19 +229,19 @@ module Ittybit
     # @param page [Integer]
     # @param limit [Integer]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::FileListResponse]
+    # @return [Ittybit::Files::FilesListResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.files.list
     def list(page: nil, 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?
-          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
         **(req.headers || {}),
@@ -252,7 +254,7 @@ module Ittybit
           end
           req.url "#{@request_client.get_url(request_options: request_options)}/files"
         end
-        Ittybit::FileListResponse.from_json(json_object: response.body)
+        Ittybit::Files::FilesListResponse.from_json(json_object: response.body)
       end
     end
 
@@ -265,24 +267,24 @@ module Ittybit
     # @param ref [String]
     # @param metadata [Hash{String => Object}]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::FileResponse]
+    # @return [Ittybit::Files::FilesCreateResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.files.create(
     #    url: "https://ittyb.it/sample.mp4",
     #    folder: "ittybit/samples",
     #    filename: "video.mp4",
-    #    metadata: { "customKey2": "a different custom value" }
+    #    metadata: { "customKey": "your custom value" }
     #  )
     def create(url:, media_id: nil, folder: nil, filename: nil, ref: nil, metadata: 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?
-          req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
         **(req.headers || {}),
@@ -303,7 +305,7 @@ module Ittybit
           }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/files"
         end
-        Ittybit::FileResponse.from_json(json_object: response.body)
+        Ittybit::Files::FilesCreateResponse.from_json(json_object: response.body)
       end
     end
 
@@ -311,19 +313,19 @@ module Ittybit
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::FileResponse]
+    # @return [Ittybit::Files::FilesGetResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.files.get(id: "file_abcdefgh1234")
     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["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
         **(req.headers || {}),
@@ -338,7 +340,7 @@ module Ittybit
           end
           req.url "#{@request_client.get_url(request_options: request_options)}/files/#{id}"
         end
-        Ittybit::FileResponse.from_json(json_object: response.body)
+        Ittybit::Files::FilesGetResponse.from_json(json_object: response.body)
       end
     end
 
@@ -346,19 +348,19 @@ module Ittybit
     #
     # @param id [String]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::ConfirmationResponse]
+    # @return [Ittybit::Files::FilesDeleteResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.files.delete(id: "file_abcdefgh1234")
     def delete(id:, request_options: nil)
       Async do
         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["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
         **(req.headers || {}),
@@ -373,7 +375,7 @@ module Ittybit
           end
           req.url "#{@request_client.get_url(request_options: request_options)}/files/#{id}"
         end
-        Ittybit::ConfirmationResponse.from_json(json_object: response.body)
+        Ittybit::Files::FilesDeleteResponse.from_json(json_object: response.body)
       end
     end
 
@@ -386,12 +388,12 @@ module Ittybit
     # @param ref [String]
     # @param metadata [Hash{String => Object}]
     # @param request_options [Ittybit::RequestOptions]
-    # @return [Ittybit::FileResponse]
+    # @return [Ittybit::Files::FilesUpdateResponse]
     # @example
     #  api = Ittybit::Client.new(
     #    base_url: "https://api.example.com",
     #    environment: Ittybit::Environment::DEFAULT,
-    #    token: "YOUR_AUTH_TOKEN"
+    #    api_key: "YOUR_AUTH_TOKEN"
     #  )
     #  api.files.update(
     #    id: "file_abcdefgh1234",
@@ -403,7 +405,7 @@ module Ittybit
       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["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
           req.headers = {
         **(req.headers || {}),
@@ -422,7 +424,7 @@ module Ittybit
           }.compact
           req.url "#{@request_client.get_url(request_options: request_options)}/files/#{id}"
         end
-        Ittybit::FileResponse.from_json(json_object: response.body)
+        Ittybit::Files::FilesUpdateResponse.from_json(json_object: response.body)
       end
     end
   end