scalar_api_ruby 0.2.0

data/lib/scalar_api_ruby/models/theme_replace_document_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Themes#replace_document
+    class ThemeReplaceDocumentParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute document
+      #
+      #   @return [String]
+      required :document, String
+
+      # @!method initialize(slug:, document:, request_options: {})
+      #   @param slug [String]
+      #   @param document [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/theme_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Themes#retrieve
+    class ThemeRetrieveParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!method initialize(slug:, request_options: {})
+      #   @param slug [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/theme_retrieve_response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    ThemeRetrieveResponse = String
+  end
+end

data/lib/scalar_api_ruby/models/theme_update_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Themes#update
+    class ThemeUpdateParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(slug:, description: nil, name: nil, request_options: {})
+      #   @param slug [String]
+      #   @param description [String]
+      #   @param name [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/timestamp.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    Timestamp = Integer
+  end
+end

data/lib/scalar_api_ruby/models/uid.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    class UID < Scalar::Internal::Type::BaseModel
+      # @!attribute uid
+      #
+      #   @return [String]
+      required :uid, String
+
+      # @!method initialize(uid:)
+      #   @param uid [String]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/user.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Authentication#list_current_user
+    class User < Scalar::Internal::Type::BaseModel
+      # @!attribute active_team_id
+      #
+      #   @return [String, nil]
+      required :active_team_id, String, api_name: :activeTeamId, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Integer]
+      required :created_at, Integer, api_name: :createdAt
+
+      # @!attribute email
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute has_github
+      #
+      #   @return [Boolean]
+      required :has_github, Scalar::Internal::Type::Boolean, api_name: :hasGithub
+
+      # @!attribute teams
+      #
+      #   @return [Array<Scalar::Models::TeamSummary>]
+      required :teams, -> { Scalar::Internal::Type::ArrayOf[Scalar::TeamSummary] }
+
+      # @!attribute uid
+      #
+      #   @return [String]
+      required :uid, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Integer]
+      required :updated_at, Integer, api_name: :updatedAt
+
+      # @!attribute theme
+      #
+      #   @return [String, nil]
+      optional :theme, String
+
+      # @!method initialize(active_team_id:, created_at:, email:, has_github:, teams:, uid:, updated_at:, theme: nil)
+      #   @param active_team_id [String, nil]
+      #   @param created_at [Integer]
+      #   @param email [String]
+      #   @param has_github [Boolean]
+      #   @param teams [Array<Scalar::Models::TeamSummary>]
+      #   @param uid [String]
+      #   @param updated_at [Integer]
+      #   @param theme [String]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    Version = String
+  end
+end

data/lib/scalar_api_ruby/models.rb

@@ -0,0 +1,248 @@
+# frozen_string_literal: true
+
+module Scalar
+  [Scalar::Internal::Type::BaseModel, *Scalar::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Scalar::Internal::AnyHash) } }
+  end
+
+  Scalar::Internal::Util
+    .walk_namespaces(Scalar::Models)
+    .each do |mod|
+      case mod
+      in Scalar::Internal::Type::Enum | Scalar::Internal::Type::Union
+        mod.constants.each do |name|
+          case mod.const_get(name)
+          in true | false
+            mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+            mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+          in Integer
+            mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+            mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+          in Float
+            mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+            mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+          in Symbol
+            mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+            mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+          else
+          end
+        end
+      else
+      end
+    end
+
+  Scalar::Internal::Util
+    .walk_namespaces(Scalar::Models)
+    .lazy
+    .grep(Scalar::Internal::Type::Union)
+    .each do |mod|
+      const = :Variants
+      next if mod.sorbet_constant_defined?(const)
+
+      mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+    end
+
+  AccessGroup = Scalar::Models::AccessGroup
+
+  AccessGroupCreateParams = Scalar::Models::AccessGroupCreateParams
+
+  AccessGroupDeleteParams = Scalar::Models::AccessGroupDeleteParams
+
+  AccessGroupName = Scalar::Models::AccessGroupName
+
+  AccessGroupRetrieveParams = Scalar::Models::AccessGroupRetrieveParams
+
+  AccessGroups = Scalar::Models::AccessGroups
+
+  AccessGroupUpdateParams = Scalar::Models::AccessGroupUpdateParams
+
+  ActiveDeployment = Scalar::Models::ActiveDeployment
+
+  APIDocument = Scalar::Models::APIDocument
+
+  AuthenticationExchangePersonalTokenParams = Scalar::Models::AuthenticationExchangePersonalTokenParams
+
+  AuthenticationListCurrentUserParams = Scalar::Models::AuthenticationListCurrentUserParams
+
+  DocsProject = Scalar::Models::DocsProject
+
+  GithubProject = Scalar::Models::GithubProject
+
+  GithubProjectRepository = Scalar::Models::GithubProjectRepository
+
+  LoginPortal = Scalar::Models::LoginPortal
+
+  LoginPortalCreateParams = Scalar::Models::LoginPortalCreateParams
+
+  LoginPortalDeleteParams = Scalar::Models::LoginPortalDeleteParams
+
+  LoginPortalEmail = Scalar::Models::LoginPortalEmail
+
+  LoginPortalListParams = Scalar::Models::LoginPortalListParams
+
+  LoginPortalPage = Scalar::Models::LoginPortalPage
+
+  LoginPortalRetrieveParams = Scalar::Models::LoginPortalRetrieveParams
+
+  LoginPortalUpdateParams = Scalar::Models::LoginPortalUpdateParams
+
+  ManagedDocVersion = Scalar::Models::ManagedDocVersion
+
+  ManagedSchemaVersion = Scalar::Models::ManagedSchemaVersion
+
+  Mcp = Scalar::Models::Mcp
+
+  Method = Scalar::Models::Method
+
+  Namespace = Scalar::Models::Namespace
+
+  NamespaceListParams = Scalar::Models::NamespaceListParams
+
+  Nanoid = Scalar::Models::Nanoid
+
+  RegistryCreateAPIDocumentAccessGroupParams = Scalar::Models::RegistryCreateAPIDocumentAccessGroupParams
+
+  RegistryCreateAPIDocumentParams = Scalar::Models::RegistryCreateAPIDocumentParams
+
+  RegistryCreateAPIDocumentVersionParams = Scalar::Models::RegistryCreateAPIDocumentVersionParams
+
+  RegistryDeleteAPIDocumentAccessGroupParams = Scalar::Models::RegistryDeleteAPIDocumentAccessGroupParams
+
+  RegistryDeleteAPIDocumentParams = Scalar::Models::RegistryDeleteAPIDocumentParams
+
+  RegistryDeleteAPIDocumentVersionParams = Scalar::Models::RegistryDeleteAPIDocumentVersionParams
+
+  RegistryListAllAPIDocumentsParams = Scalar::Models::RegistryListAllAPIDocumentsParams
+
+  RegistryListAPIDocumentsParams = Scalar::Models::RegistryListAPIDocumentsParams
+
+  RegistryListAPIDocumentVersionMetadataParams = Scalar::Models::RegistryListAPIDocumentVersionMetadataParams
+
+  RegistryRetrieveAPIDocumentVersionParams = Scalar::Models::RegistryRetrieveAPIDocumentVersionParams
+
+  RegistryUpdateAPIDocumentParams = Scalar::Models::RegistryUpdateAPIDocumentParams
+
+  RegistryUpdateAPIDocumentVersionParams = Scalar::Models::RegistryUpdateAPIDocumentVersionParams
+
+  Rule = Scalar::Models::Rule
+
+  RuleCreateRulesetAccessGroupParams = Scalar::Models::RuleCreateRulesetAccessGroupParams
+
+  RuleCreateRulesetParams = Scalar::Models::RuleCreateRulesetParams
+
+  RuleDeleteRulesetAccessGroupParams = Scalar::Models::RuleDeleteRulesetAccessGroupParams
+
+  RuleDeleteRulesetParams = Scalar::Models::RuleDeleteRulesetParams
+
+  RuleListRulesetsParams = Scalar::Models::RuleListRulesetsParams
+
+  RuleRetrieveRulesetDocumentParams = Scalar::Models::RuleRetrieveRulesetDocumentParams
+
+  RuleUpdateRulesetParams = Scalar::Models::RuleUpdateRulesetParams
+
+  ScalarDocCreateGuideParams = Scalar::Models::ScalarDocCreateGuideParams
+
+  ScalarDocCreateProjectParams = Scalar::Models::ScalarDocCreateProjectParams
+
+  ScalarDocDeleteProjectParams = Scalar::Models::ScalarDocDeleteProjectParams
+
+  ScalarDocListGuidesParams = Scalar::Models::ScalarDocListGuidesParams
+
+  ScalarDocListProjectConfigParams = Scalar::Models::ScalarDocListProjectConfigParams
+
+  ScalarDocListProjectDomainParams = Scalar::Models::ScalarDocListProjectDomainParams
+
+  ScalarDocListProjectDomainStatusParams = Scalar::Models::ScalarDocListProjectDomainStatusParams
+
+  ScalarDocListProjectsParams = Scalar::Models::ScalarDocListProjectsParams
+
+  ScalarDocPublishGuideParams = Scalar::Models::ScalarDocPublishGuideParams
+
+  ScalarDocPublishProjectParams = Scalar::Models::ScalarDocPublishProjectParams
+
+  ScalarDocRetrieveProjectParams = Scalar::Models::ScalarDocRetrieveProjectParams
+
+  ScalarDocUpdateProjectConfigParams = Scalar::Models::ScalarDocUpdateProjectConfigParams
+
+  ScalarDocUpdateProjectParams = Scalar::Models::ScalarDocUpdateProjectParams
+
+  Schema = Scalar::Models::Schema
+
+  SchemaCreateParams = Scalar::Models::SchemaCreateParams
+
+  SchemaDeleteParams = Scalar::Models::SchemaDeleteParams
+
+  SchemaListParams = Scalar::Models::SchemaListParams
+
+  Schemas = Scalar::Models::Schemas
+
+  SchemaUpdateParams = Scalar::Models::SchemaUpdateParams
+
+  Sdk = Scalar::Models::Sdk
+
+  SdkBuildParams = Scalar::Models::SdkBuildParams
+
+  SdkCreateParams = Scalar::Models::SdkCreateParams
+
+  SdkDeleteParams = Scalar::Models::SdkDeleteParams
+
+  SdkListParams = Scalar::Models::SdkListParams
+
+  SdkRetrieveParams = Scalar::Models::SdkRetrieveParams
+
+  Sdks = Scalar::Models::Sdks
+
+  SdkTargetSummary = Scalar::Models::SdkTargetSummary
+
+  SdkUpdateParams = Scalar::Models::SdkUpdateParams
+
+  SdkVersion = Scalar::Models::SdkVersion
+
+  Slug = Scalar::Models::Slug
+
+  Team = Scalar::Models::Team
+
+  TeamImage = Scalar::Models::TeamImage
+
+  TeamListParams = Scalar::Models::TeamListParams
+
+  TeamName = Scalar::Models::TeamName
+
+  Teams = Scalar::Models::Teams
+
+  TeamSummary = Scalar::Models::TeamSummary
+
+  Theme = Scalar::Models::Theme
+
+  ThemeCreateParams = Scalar::Models::ThemeCreateParams
+
+  ThemeDeleteParams = Scalar::Models::ThemeDeleteParams
+
+  ThemeListParams = Scalar::Models::ThemeListParams
+
+  ThemeReplaceDocumentParams = Scalar::Models::ThemeReplaceDocumentParams
+
+  ThemeRetrieveParams = Scalar::Models::ThemeRetrieveParams
+
+  ThemeUpdateParams = Scalar::Models::ThemeUpdateParams
+
+  Timestamp = Scalar::Models::Timestamp
+
+  UID = Scalar::Models::UID
+
+  User = Scalar::Models::User
+
+  Value400 = Scalar::Models::Value400
+
+  Value401 = Scalar::Models::Value401
+
+  Value403 = Scalar::Models::Value403
+
+  Value404 = Scalar::Models::Value404
+
+  Value422 = Scalar::Models::Value422
+
+  Value500 = Scalar::Models::Value500
+
+  Version = Scalar::Models::Version
+end

data/lib/scalar_api_ruby/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Scalar
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Scalar::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Scalar::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, Scalar::Internal::Type::HashOf[Scalar::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, Scalar::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, Scalar::Internal::Type::HashOf[Scalar::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(Scalar::RequestOptions, Scalar::Internal::AnyHash) }
+    end
+  end
+end

data/lib/scalar_api_ruby/resources/access_groups/domains.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Resources
+    class AccessGroups
+      # Access Groups
+      class Domains
+        # Allow an exact email domain in a group. Requires docs edit permission. A group
+        # supports up to 1000 domains.
+        #
+        # @overload create(slug, domain:, request_options: {})
+        #
+        # @param slug [String]
+        # @param domain [String]
+        # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Object]
+        #
+        # @see Scalar::Models::AccessGroups::DomainCreateParams
+        def create(slug, params)
+          parsed, options = Scalar::AccessGroups::DomainCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["v1/access-groups/%1$s/domains", slug],
+            body: parsed,
+            model: Scalar::Internal::Type::Unknown,
+            options: options
+          )
+        end
+
+        # Remove an exact email domain from a group. Requires docs edit permission. Other
+        # allowed domains and emails are preserved.
+        #
+        # @overload delete(slug, domain:, request_options: {})
+        #
+        # @param slug [String]
+        # @param domain [String]
+        # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Object]
+        #
+        # @see Scalar::Models::AccessGroups::DomainDeleteParams
+        def delete(slug, params)
+          parsed, options = Scalar::AccessGroups::DomainDeleteParams.dump_request(params)
+          @client.request(
+            method: :delete,
+            path: ["v1/access-groups/%1$s/domains", slug],
+            body: parsed,
+            model: Scalar::Internal::Type::Unknown,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Scalar::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/scalar_api_ruby/resources/access_groups.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Resources
+    # Access Groups
+    class AccessGroups
+      # Access Groups
+      # @return [Scalar::Resources::AccessGroups::Domains]
+      attr_reader :domains
+
+      # Create a group for the current team. Requires docs edit permission and the
+      # access groups billing feature. Domains are exact email domains, without
+      # wildcards or implicit subdomain matching.
+      #
+      # @overload create(allowed_domains: nil, name: nil, slug: nil, request_options: {})
+      #
+      # @param allowed_domains [String]
+      # @param name [String]
+      # @param slug [String]
+      # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Scalar::Models::AccessGroupCreateResponse]
+      #
+      # @see Scalar::Models::AccessGroupCreateParams
+      def create(params = {})
+        parsed, options = Scalar::AccessGroupCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/access-groups",
+          body: parsed,
+          model: Scalar::Models::AccessGroupCreateResponse,
+          options: options
+        )
+      end
+
+      # Get a group and its email and domain allowlists by slug.
+      #
+      # @overload retrieve(slug, request_options: {})
+      #
+      # @param slug [String]
+      # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Scalar::Models::AccessGroupRetrieveResponse]
+      #
+      # @see Scalar::Models::AccessGroupRetrieveParams
+      def retrieve(slug, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/access-groups/%1$s", slug],
+          model: Scalar::Models::AccessGroupRetrieveResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Update group metadata. Requires docs edit permission. After changing the slug,
+      # use the new slug in subsequent requests.
+      #
+      # @overload update(path_slug, name: nil, body_slug: nil, request_options: {})
+      #
+      # @param path_slug [String]
+      # @param name [String]
+      # @param body_slug [String]
+      # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Object]
+      #
+      # @see Scalar::Models::AccessGroupUpdateParams
+      def update(path_slug, params = {})
+        parsed, options = Scalar::AccessGroupUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/access-groups/%1$s", path_slug],
+          body: parsed,
+          model: Scalar::Internal::Type::Unknown,
+          options: options
+        )
+      end
+
+      # Delete a group and remove its project assignments. Requires docs edit
+      # permission.
+      #
+      # @overload delete(slug, request_options: {})
+      #
+      # @param slug [String]
+      # @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Object]
+      #
+      # @see Scalar::Models::AccessGroupDeleteParams
+      def delete(slug, params = {})
+        @client.request(
+          method: :delete,
+          path: ["v1/access-groups/%1$s", slug],
+          model: Scalar::Internal::Type::Unknown,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Scalar::Client]
+      def initialize(client:)
+        @client = client
+        @domains = Scalar::Resources::AccessGroups::Domains.new(client: client)
+      end
+    end
+  end
+end