openlayer 0.8.0 → 0.9.0

data/lib/openlayer/models/workspace_update_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    # @see Openlayer::Resources::Workspaces#update
+    class WorkspaceUpdateParams < Openlayer::Internal::Type::BaseModel
+      extend Openlayer::Internal::Type::RequestParameters::Converter
+      include Openlayer::Internal::Type::RequestParameters
+
+      # @!attribute invite_code
+      #   The workspace invite code.
+      #
+      #   @return [String, nil]
+      optional :invite_code, String, api_name: :inviteCode
+
+      # @!attribute name
+      #   The workspace name.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute slug
+      #   The workspace slug.
+      #
+      #   @return [String, nil]
+      optional :slug, String
+
+      # @!method initialize(invite_code: nil, name: nil, slug: nil, request_options: {})
+      #   @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}]
+    end
+  end
+end

data/lib/openlayer/models/workspace_update_response.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    # @see Openlayer::Resources::Workspaces#update
+    class WorkspaceUpdateResponse < Openlayer::Internal::Type::BaseModel
+      # @!attribute name
+      #   The workspace name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute slug
+      #   The workspace slug.
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute saml_only_access
+      #   Whether the workspace only allows SAML authentication.
+      #
+      #   @return [Boolean, nil]
+      optional :saml_only_access, Openlayer::Internal::Type::Boolean, api_name: :samlOnlyAccess
+
+      # @!attribute wildcard_domains
+      #
+      #   @return [Array<String>, nil]
+      optional :wildcard_domains, Openlayer::Internal::Type::ArrayOf[String], api_name: :wildcardDomains
+
+      response_only do
+        # @!attribute id
+        #   The workspace id.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute creator_id
+        #   The workspace creator id.
+        #
+        #   @return [String, nil]
+        required :creator_id, String, api_name: :creatorId, nil?: true
+
+        # @!attribute date_created
+        #   The workspace creation date.
+        #
+        #   @return [Time]
+        required :date_created, Time, api_name: :dateCreated
+
+        # @!attribute date_updated
+        #   The workspace last updated date.
+        #
+        #   @return [Time]
+        required :date_updated, Time, api_name: :dateUpdated
+
+        # @!attribute invite_count
+        #   The number of invites in the workspace.
+        #
+        #   @return [Integer]
+        required :invite_count, Integer, api_name: :inviteCount
+
+        # @!attribute member_count
+        #   The number of members in the workspace.
+        #
+        #   @return [Integer]
+        required :member_count, Integer, api_name: :memberCount
+
+        # @!attribute period_end_date
+        #   The end date of the current billing period.
+        #
+        #   @return [Time, nil]
+        required :period_end_date, Time, api_name: :periodEndDate, nil?: true
+
+        # @!attribute period_start_date
+        #   The start date of the current billing period.
+        #
+        #   @return [Time, nil]
+        required :period_start_date, Time, api_name: :periodStartDate, nil?: true
+
+        # @!attribute project_count
+        #   The number of projects in the workspace.
+        #
+        #   @return [Integer]
+        required :project_count, Integer, api_name: :projectCount
+
+        # @!attribute status
+        #
+        #   @return [Symbol, Openlayer::Models::WorkspaceUpdateResponse::Status]
+        required :status, enum: -> { Openlayer::Models::WorkspaceUpdateResponse::Status }
+
+        # @!attribute monthly_usage
+        #
+        #   @return [Array<Openlayer::Models::WorkspaceUpdateResponse::MonthlyUsage>, nil]
+        optional :monthly_usage,
+                 -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::WorkspaceUpdateResponse::MonthlyUsage] },
+                 api_name: :monthlyUsage
+      end
+
+      # @!method initialize(id:, creator_id:, date_created:, date_updated:, invite_count:, member_count:, name:, period_end_date:, period_start_date:, project_count:, slug:, status:, monthly_usage: nil, saml_only_access: nil, wildcard_domains: nil)
+      #   @param id [String] The workspace id.
+      #
+      #   @param creator_id [String, nil] The workspace creator id.
+      #
+      #   @param date_created [Time] The workspace creation date.
+      #
+      #   @param date_updated [Time] The workspace last updated date.
+      #
+      #   @param invite_count [Integer] The number of invites in the workspace.
+      #
+      #   @param member_count [Integer] The number of members in the workspace.
+      #
+      #   @param name [String] The workspace name.
+      #
+      #   @param period_end_date [Time, nil] The end date of the current billing period.
+      #
+      #   @param period_start_date [Time, nil] The start date of the current billing period.
+      #
+      #   @param project_count [Integer] The number of projects in the workspace.
+      #
+      #   @param slug [String] The workspace slug.
+      #
+      #   @param status [Symbol, Openlayer::Models::WorkspaceUpdateResponse::Status]
+      #
+      #   @param monthly_usage [Array<Openlayer::Models::WorkspaceUpdateResponse::MonthlyUsage>]
+      #
+      #   @param saml_only_access [Boolean] Whether the workspace only allows SAML authentication.
+      #
+      #   @param wildcard_domains [Array<String>]
+
+      # @see Openlayer::Models::WorkspaceUpdateResponse#status
+      module Status
+        extend Openlayer::Internal::Type::Enum
+
+        ACTIVE = :active
+        PAST_DUE = :past_due
+        UNPAID = :unpaid
+        CANCELED = :canceled
+        INCOMPLETE = :incomplete
+        INCOMPLETE_EXPIRED = :incomplete_expired
+        TRIALING = :trialing
+        PAUSED = :paused
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class MonthlyUsage < Openlayer::Internal::Type::BaseModel
+        # @!attribute execution_time_ms
+        #
+        #   @return [Integer, nil]
+        optional :execution_time_ms, Integer, api_name: :executionTimeMs, nil?: true
+
+        # @!attribute month_year
+        #
+        #   @return [Date, nil]
+        optional :month_year, Date, api_name: :monthYear
+
+        # @!attribute prediction_count
+        #
+        #   @return [Integer, nil]
+        optional :prediction_count, Integer, api_name: :predictionCount
+
+        # @!method initialize(execution_time_ms: nil, month_year: nil, prediction_count: nil)
+        #   @param execution_time_ms [Integer, nil]
+        #   @param month_year [Date]
+        #   @param prediction_count [Integer]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::APIKeys#create
+      class APIKeyCreateParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        # @!attribute name
+        #   The API key name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!method initialize(name: nil, request_options: {})
+        #   @param name [String, nil] The API key name.
+        #
+        #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::APIKeys#create
+      class APIKeyCreateResponse < Openlayer::Internal::Type::BaseModel
+        # @!attribute name
+        #   The API key name.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        response_only do
+          # @!attribute id
+          #   The API key id.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute date_created
+          #   The API key creation date.
+          #
+          #   @return [Time]
+          required :date_created, Time, api_name: :dateCreated
+
+          # @!attribute date_last_used
+          #   The API key last use date.
+          #
+          #   @return [Time, nil]
+          required :date_last_used, Time, api_name: :dateLastUsed, nil?: true
+
+          # @!attribute date_updated
+          #   The API key last update date.
+          #
+          #   @return [Time]
+          required :date_updated, Time, api_name: :dateUpdated
+
+          # @!attribute secure_key
+          #   The API key value.
+          #
+          #   @return [String]
+          required :secure_key, String, api_name: :secureKey
+        end
+
+        # @!method initialize(id:, date_created:, date_last_used:, date_updated:, secure_key:, name: nil)
+        #   @param id [String] The API key id.
+        #
+        #   @param date_created [Time] The API key creation date.
+        #
+        #   @param date_last_used [Time, nil] The API key last use date.
+        #
+        #   @param date_updated [Time] The API key last update date.
+        #
+        #   @param secure_key [String] The API key value.
+        #
+        #   @param name [String, nil] The API key name.
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::Invites#create
+      class InviteCreateParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        # @!attribute emails
+        #
+        #   @return [Array<String>, nil]
+        optional :emails, Openlayer::Internal::Type::ArrayOf[String]
+
+        # @!attribute role
+        #   The member role.
+        #
+        #   @return [Symbol, Openlayer::Models::Workspaces::InviteCreateParams::Role, nil]
+        optional :role, enum: -> { Openlayer::Workspaces::InviteCreateParams::Role }
+
+        # @!method initialize(emails: nil, role: nil, request_options: {})
+        #   @param emails [Array<String>]
+        #
+        #   @param role [Symbol, Openlayer::Models::Workspaces::InviteCreateParams::Role] The member role.
+        #
+        #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+
+        # The member role.
+        module Role
+          extend Openlayer::Internal::Type::Enum
+
+          ADMIN = :ADMIN
+          MEMBER = :MEMBER
+          VIEWER = :VIEWER
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::Invites#create
+      class InviteCreateResponse < Openlayer::Internal::Type::BaseModel
+        # @!attribute items
+        #
+        #   @return [Array<Openlayer::Models::Workspaces::InviteCreateResponse::Item>]
+        required :items,
+                 -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Workspaces::InviteCreateResponse::Item] }
+
+        # @!method initialize(items:)
+        #   @param items [Array<Openlayer::Models::Workspaces::InviteCreateResponse::Item>]
+
+        class Item < Openlayer::Internal::Type::BaseModel
+          # @!attribute creator
+          #
+          #   @return [Openlayer::Models::Workspaces::InviteCreateResponse::Item::Creator]
+          required :creator, -> { Openlayer::Models::Workspaces::InviteCreateResponse::Item::Creator }
+
+          # @!attribute email
+          #   The invite email.
+          #
+          #   @return [String]
+          required :email, String
+
+          # @!attribute role
+          #   The invite role.
+          #
+          #   @return [Symbol, Openlayer::Models::Workspaces::InviteCreateResponse::Item::Role]
+          required :role, enum: -> { Openlayer::Models::Workspaces::InviteCreateResponse::Item::Role }
+
+          # @!attribute status
+          #   The invite status.
+          #
+          #   @return [Symbol, Openlayer::Models::Workspaces::InviteCreateResponse::Item::Status]
+          required :status, enum: -> { Openlayer::Models::Workspaces::InviteCreateResponse::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::InviteCreateResponse::Item::Workspace]
+            required :workspace, -> { Openlayer::Models::Workspaces::InviteCreateResponse::Item::Workspace }
+          end
+
+          # @!method initialize(id:, creator:, date_created:, email:, role:, status:, workspace:)
+          #   @param id [String] The invite id.
+          #
+          #   @param creator [Openlayer::Models::Workspaces::InviteCreateResponse::Item::Creator]
+          #
+          #   @param date_created [Time] The invite creation date.
+          #
+          #   @param email [String] The invite email.
+          #
+          #   @param role [Symbol, Openlayer::Models::Workspaces::InviteCreateResponse::Item::Role] The invite role.
+          #
+          #   @param status [Symbol, Openlayer::Models::Workspaces::InviteCreateResponse::Item::Status] The invite status.
+          #
+          #   @param workspace [Openlayer::Models::Workspaces::InviteCreateResponse::Item::Workspace]
+
+          # @see Openlayer::Models::Workspaces::InviteCreateResponse::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::InviteCreateResponse::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::InviteCreateResponse::Item#status
+          module Status
+            extend Openlayer::Internal::Type::Enum
+
+            ACCEPTED = :accepted
+            PENDING = :pending
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Openlayer::Models::Workspaces::InviteCreateResponse::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/workspaces/invite_list_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Workspaces
+      # @see Openlayer::Resources::Workspaces::Invites#list
+      class InviteListParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        # @!attribute page
+        #   The page to return in a paginated query.
+        #
+        #   @return [Integer, nil]
+        optional :page, Integer
+
+        # @!attribute per_page
+        #   Maximum number of items to return per page.
+        #
+        #   @return [Integer, nil]
+        optional :per_page, Integer
+
+        # @!method initialize(page: nil, per_page: nil, request_options: {})
+        #   @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}]
+      end
+    end
+  end
+end