openlayer 0.8.0 → 0.9.0

data/lib/openlayer/models/workspaces/invite_list_response.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::Invites#list
+      class InviteListResponse < Openlayer::Internal::Type::BaseModel
+        # @!attribute _meta
+        #
+        #   @return [Openlayer::Models::Workspaces::InviteListResponse::Meta]
+        required :_meta, -> { Openlayer::Models::Workspaces::InviteListResponse::Meta }
+
+        # @!attribute items
+        #
+        #   @return [Array<Openlayer::Models::Workspaces::InviteListResponse::Item>]
+        required :items,
+                 -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Workspaces::InviteListResponse::Item] }
+
+        # @!method initialize(_meta:, items:)
+        #   @param _meta [Openlayer::Models::Workspaces::InviteListResponse::Meta]
+        #   @param items [Array<Openlayer::Models::Workspaces::InviteListResponse::Item>]
+
+        # @see Openlayer::Models::Workspaces::InviteListResponse#_meta
+        class Meta < Openlayer::Internal::Type::BaseModel
+          # @!attribute page
+          #   The current page.
+          #
+          #   @return [Integer]
+          required :page, Integer
+
+          # @!attribute per_page
+          #   The number of items per page.
+          #
+          #   @return [Integer]
+          required :per_page, Integer, api_name: :perPage
+
+          # @!attribute total_items
+          #   The total number of items.
+          #
+          #   @return [Integer]
+          required :total_items, Integer, api_name: :totalItems
+
+          # @!attribute total_pages
+          #   The total number of pages.
+          #
+          #   @return [Integer]
+          required :total_pages, Integer, api_name: :totalPages
+
+          # @!method initialize(page:, per_page:, total_items:, total_pages:)
+          #   @param page [Integer] The current page.
+          #
+          #   @param per_page [Integer] The number of items per page.
+          #
+          #   @param total_items [Integer] The total number of items.
+          #
+          #   @param total_pages [Integer] The total number of pages.
+        end
+
+        class Item < Openlayer::Internal::Type::BaseModel
+          # @!attribute creator
+          #
+          #   @return [Openlayer::Models::Workspaces::InviteListResponse::Item::Creator]
+          required :creator, -> { Openlayer::Models::Workspaces::InviteListResponse::Item::Creator }
+
+          # @!attribute email
+          #   The invite email.
+          #
+          #   @return [String]
+          required :email, String
+
+          # @!attribute role
+          #   The invite role.
+          #
+          #   @return [Symbol, Openlayer::Models::Workspaces::InviteListResponse::Item::Role]
+          required :role, enum: -> { Openlayer::Models::Workspaces::InviteListResponse::Item::Role }
+
+          # @!attribute status
+          #   The invite status.
+          #
+          #   @return [Symbol, Openlayer::Models::Workspaces::InviteListResponse::Item::Status]
+          required :status, enum: -> { Openlayer::Models::Workspaces::InviteListResponse::Item::Status }
+
+          response_only do
+            # @!attribute id
+            #   The invite id.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute date_created
+            #   The invite creation date.
+            #
+            #   @return [Time]
+            required :date_created, Time, api_name: :dateCreated
+
+            # @!attribute workspace
+            #
+            #   @return [Openlayer::Models::Workspaces::InviteListResponse::Item::Workspace]
+            required :workspace, -> { Openlayer::Models::Workspaces::InviteListResponse::Item::Workspace }
+          end
+
+          # @!method initialize(id:, creator:, date_created:, email:, role:, status:, workspace:)
+          #   @param id [String] The invite id.
+          #
+          #   @param creator [Openlayer::Models::Workspaces::InviteListResponse::Item::Creator]
+          #
+          #   @param date_created [Time] The invite creation date.
+          #
+          #   @param email [String] The invite email.
+          #
+          #   @param role [Symbol, Openlayer::Models::Workspaces::InviteListResponse::Item::Role] The invite role.
+          #
+          #   @param status [Symbol, Openlayer::Models::Workspaces::InviteListResponse::Item::Status] The invite status.
+          #
+          #   @param workspace [Openlayer::Models::Workspaces::InviteListResponse::Item::Workspace]
+
+          # @see Openlayer::Models::Workspaces::InviteListResponse::Item#creator
+          class Creator < Openlayer::Internal::Type::BaseModel
+            # @!attribute name
+            #   The invite creator name.
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute username
+            #   The invite creator username.
+            #
+            #   @return [String, nil]
+            optional :username, String, nil?: true
+
+            response_only do
+              # @!attribute id
+              #   The invite creator id.
+              #
+              #   @return [String, nil]
+              optional :id, String
+            end
+
+            # @!method initialize(id: nil, name: nil, username: nil)
+            #   @param id [String] The invite creator id.
+            #
+            #   @param name [String, nil] The invite creator name.
+            #
+            #   @param username [String, nil] The invite creator username.
+          end
+
+          # The invite role.
+          #
+          # @see Openlayer::Models::Workspaces::InviteListResponse::Item#role
+          module Role
+            extend Openlayer::Internal::Type::Enum
+
+            ADMIN = :ADMIN
+            MEMBER = :MEMBER
+            VIEWER = :VIEWER
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The invite status.
+          #
+          # @see Openlayer::Models::Workspaces::InviteListResponse::Item#status
+          module Status
+            extend Openlayer::Internal::Type::Enum
+
+            ACCEPTED = :accepted
+            PENDING = :pending
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Openlayer::Models::Workspaces::InviteListResponse::Item#workspace
+          class Workspace < Openlayer::Internal::Type::BaseModel
+            # @!attribute name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute slug
+            #
+            #   @return [String]
+            required :slug, String
+
+            response_only do
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute date_created
+              #
+              #   @return [Time]
+              required :date_created, Time, api_name: :dateCreated
+
+              # @!attribute member_count
+              #
+              #   @return [Integer]
+              required :member_count, Integer, api_name: :memberCount
+            end
+
+            # @!method initialize(id:, date_created:, member_count:, name:, slug:)
+            #   @param id [String]
+            #   @param date_created [Time]
+            #   @param member_count [Integer]
+            #   @param name [String]
+            #   @param slug [String]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/models.rb

@@ -60,4 +60,10 @@ module Openlayer
   Storage = Openlayer::Models::Storage
 
   TestEvaluateParams = Openlayer::Models::TestEvaluateParams
+
+  WorkspaceRetrieveParams = Openlayer::Models::WorkspaceRetrieveParams
+
+  Workspaces = Openlayer::Models::Workspaces
+
+  WorkspaceUpdateParams = Openlayer::Models::WorkspaceUpdateParams
 end

data/lib/openlayer/resources/workspaces/api_keys.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Workspaces
+      class APIKeys
+        # Create a new API key in a workspace.
+        #
+        # @overload create(workspace_id, name: nil, request_options: {})
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param name [String, nil] The API key name.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Workspaces::APIKeyCreateResponse]
+        #
+        # @see Openlayer::Models::Workspaces::APIKeyCreateParams
+        def create(workspace_id, params = {})
+          parsed, options = Openlayer::Workspaces::APIKeyCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["workspaces/%1$s/api-keys", workspace_id],
+            body: parsed,
+            model: Openlayer::Models::Workspaces::APIKeyCreateResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/resources/workspaces/invites.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Workspaces
+      class Invites
+        # Invite users to a workspace.
+        #
+        # @overload create(workspace_id, emails: nil, role: nil, request_options: {})
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param emails [Array<String>]
+        #
+        # @param role [Symbol, Openlayer::Models::Workspaces::InviteCreateParams::Role] The member role.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Workspaces::InviteCreateResponse]
+        #
+        # @see Openlayer::Models::Workspaces::InviteCreateParams
+        def create(workspace_id, params = {})
+          parsed, options = Openlayer::Workspaces::InviteCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["workspaces/%1$s/invites", workspace_id],
+            body: parsed,
+            model: Openlayer::Models::Workspaces::InviteCreateResponse,
+            options: options
+          )
+        end
+
+        # Retrieve a list of invites in a workspace.
+        #
+        # @overload list(workspace_id, page: nil, per_page: nil, request_options: {})
+        #
+        # @param workspace_id [String] The workspace id.
+        #
+        # @param page [Integer] The page to return in a paginated query.
+        #
+        # @param per_page [Integer] Maximum number of items to return per page.
+        #
+        # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Openlayer::Models::Workspaces::InviteListResponse]
+        #
+        # @see Openlayer::Models::Workspaces::InviteListParams
+        def list(workspace_id, params = {})
+          parsed, options = Openlayer::Workspaces::InviteListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["workspaces/%1$s/invites", workspace_id],
+            query: parsed.transform_keys(per_page: "perPage"),
+            model: Openlayer::Models::Workspaces::InviteListResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Openlayer::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/resources/workspaces.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Resources
+    class Workspaces
+      # @return [Openlayer::Resources::Workspaces::Invites]
+      attr_reader :invites
+
+      # @return [Openlayer::Resources::Workspaces::APIKeys]
+      attr_reader :api_keys
+
+      # Retrieve a workspace by its ID.
+      #
+      # @overload retrieve(workspace_id, request_options: {})
+      #
+      # @param workspace_id [String] The workspace id.
+      #
+      # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Openlayer::Models::WorkspaceRetrieveResponse]
+      #
+      # @see Openlayer::Models::WorkspaceRetrieveParams
+      def retrieve(workspace_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["workspaces/%1$s", workspace_id],
+          model: Openlayer::Models::WorkspaceRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Update a workspace.
+      #
+      # @overload update(workspace_id, invite_code: nil, name: nil, slug: nil, request_options: {})
+      #
+      # @param workspace_id [String] The workspace id.
+      #
+      # @param invite_code [String] The workspace invite code.
+      #
+      # @param name [String] The workspace name.
+      #
+      # @param slug [String] The workspace slug.
+      #
+      # @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Openlayer::Models::WorkspaceUpdateResponse]
+      #
+      # @see Openlayer::Models::WorkspaceUpdateParams
+      def update(workspace_id, params = {})
+        parsed, options = Openlayer::WorkspaceUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["workspaces/%1$s", workspace_id],
+          body: parsed,
+          model: Openlayer::Models::WorkspaceUpdateResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Openlayer::Client]
+      def initialize(client:)
+        @client = client
+        @invites = Openlayer::Resources::Workspaces::Invites.new(client: client)
+        @api_keys = Openlayer::Resources::Workspaces::APIKeys.new(client: client)
+      end
+    end
+  end
+end

data/lib/openlayer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openlayer
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/openlayer.rb

@@ -89,6 +89,16 @@ require_relative "openlayer/models/storage/presigned_url_create_params"
 require_relative "openlayer/models/storage/presigned_url_create_response"
 require_relative "openlayer/models/test_evaluate_params"
 require_relative "openlayer/models/test_evaluate_response"
+require_relative "openlayer/models/workspace_retrieve_params"
+require_relative "openlayer/models/workspace_retrieve_response"
+require_relative "openlayer/models/workspaces/api_key_create_params"
+require_relative "openlayer/models/workspaces/api_key_create_response"
+require_relative "openlayer/models/workspaces/invite_create_params"
+require_relative "openlayer/models/workspaces/invite_create_response"
+require_relative "openlayer/models/workspaces/invite_list_params"
+require_relative "openlayer/models/workspaces/invite_list_response"
+require_relative "openlayer/models/workspace_update_params"
+require_relative "openlayer/models/workspace_update_response"
 require_relative "openlayer/models"
 require_relative "openlayer/resources/commits"
 require_relative "openlayer/resources/commits/test_results"
@@ -103,3 +113,6 @@ require_relative "openlayer/resources/projects/tests"
 require_relative "openlayer/resources/storage"
 require_relative "openlayer/resources/storage/presigned_url"
 require_relative "openlayer/resources/tests"
+require_relative "openlayer/resources/workspaces"
+require_relative "openlayer/resources/workspaces/api_keys"
+require_relative "openlayer/resources/workspaces/invites"

data/rbi/openlayer/client.rbi

@@ -16,6 +16,9 @@ module Openlayer
     sig { returns(Openlayer::Resources::Projects) }
     attr_reader :projects
 
+    sig { returns(Openlayer::Resources::Workspaces) }
+    attr_reader :workspaces
+
     sig { returns(Openlayer::Resources::Commits) }
     attr_reader :commits
 

data/rbi/openlayer/models/workspace_retrieve_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    class WorkspaceRetrieveParams < Openlayer::Internal::Type::BaseModel
+      extend Openlayer::Internal::Type::RequestParameters::Converter
+      include Openlayer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Openlayer::WorkspaceRetrieveParams,
+            Openlayer::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Openlayer::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Openlayer::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end