scalar_api_ruby 0.2.0

data/lib/scalar_api_ruby/models/sdk.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Sdks#retrieve
+    class Sdk < Scalar::Internal::Type::BaseModel
+      # @!attribute api_uid
+      #
+      #   @return [String, nil]
+      required :api_uid, String, api_name: :apiUid, nil?: true
+
+      # @!attribute current_version
+      #
+      #   @return [String]
+      required :current_version, String, api_name: :currentVersion
+
+      # @!attribute description
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute is_private
+      #
+      #   @return [Boolean]
+      required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate
+
+      # @!attribute namespace
+      #
+      #   @return [String]
+      required :namespace, String
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute targets
+      #
+      #   @return [Array<Scalar::Models::SdkTargetSummary>]
+      required :targets, -> { Scalar::Internal::Type::ArrayOf[Scalar::SdkTargetSummary] }
+
+      # @!attribute title
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute uid
+      #
+      #   @return [String]
+      required :uid, String
+
+      # @!attribute versions
+      #
+      #   @return [Array<Scalar::Models::SdkVersion>]
+      required :versions, -> { Scalar::Internal::Type::ArrayOf[Scalar::SdkVersion] }
+
+      # @!attribute api_version
+      #
+      #   @return [String, nil]
+      optional :api_version, String, api_name: :apiVersion, nil?: true
+
+      # @!method initialize(api_uid:, current_version:, description:, is_private:, namespace:, slug:, targets:, title:, uid:, versions:, api_version: nil)
+      #   @param api_uid [String, nil]
+      #   @param current_version [String]
+      #   @param description [String]
+      #   @param is_private [Boolean]
+      #   @param namespace [String]
+      #   @param slug [String]
+      #   @param targets [Array<Scalar::Models::SdkTargetSummary>]
+      #   @param title [String]
+      #   @param uid [String]
+      #   @param versions [Array<Scalar::Models::SdkVersion>]
+      #   @param api_version [String, nil]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/sdk_build_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Sdks#build
+    class SdkBuildParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute uid
+      #
+      #   @return [String]
+      required :uid, String
+
+      # @!attribute languages
+      #
+      #   @return [Array<Symbol, Scalar::Models::SdkBuildParams::Language>, nil]
+      optional :languages, -> { Scalar::Internal::Type::ArrayOf[enum: Scalar::SdkBuildParams::Language] }
+
+      # @!attribute version
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!method initialize(uid:, languages: nil, version: nil, request_options: {})
+      #   @param uid [String]
+      #   @param languages [Array<Symbol, Scalar::Models::SdkBuildParams::Language>]
+      #   @param version [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+
+      module Language
+        extend Scalar::Internal::Type::Enum
+
+        TYPESCRIPT = :typescript
+        PYTHON = :python
+        CLI = :cli
+        CSHARP = :csharp
+        JAVA = :java
+        RUBY = :ruby
+        PHP = :php
+        GO = :go
+        RUST = :rust
+        KOTLIN = :kotlin
+        SWIFT = :swift
+        CPP = :cpp
+        DART = :dart
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/scalar_api_ruby/models/sdk_build_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Sdks#build
+    class SdkBuildResponse < Scalar::Internal::Type::BaseModel
+      # @!attribute version
+      #
+      #   @return [String]
+      required :version, String
+
+      # @!method initialize(version:)
+      #   @param version [String]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/sdk_create_params.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Sdks#create
+    class SdkCreateParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute api_uid
+      #
+      #   @return [String]
+      required :api_uid, String, api_name: :apiUid
+
+      # @!attribute languages
+      #
+      #   @return [Array<Symbol, Scalar::Models::SdkCreateParams::Language>]
+      required :languages, -> { Scalar::Internal::Type::ArrayOf[enum: Scalar::SdkCreateParams::Language] }
+
+      # @!attribute class_name
+      #
+      #   @return [String, nil]
+      optional :class_name, String, api_name: :className
+
+      # @!attribute config
+      #
+      #   @return [String, nil]
+      optional :config, String
+
+      # @!attribute slug
+      #
+      #   @return [String, nil]
+      optional :slug, String
+
+      # @!attribute title
+      #
+      #   @return [String, nil]
+      optional :title, String
+
+      # @!method initialize(api_uid:, languages:, class_name: nil, config: nil, slug: nil, title: nil, request_options: {})
+      #   @param api_uid [String]
+      #   @param languages [Array<Symbol, Scalar::Models::SdkCreateParams::Language>]
+      #   @param class_name [String]
+      #   @param config [String]
+      #   @param slug [String]
+      #   @param title [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+
+      module Language
+        extend Scalar::Internal::Type::Enum
+
+        TYPESCRIPT = :typescript
+        PYTHON = :python
+        CLI = :cli
+        CSHARP = :csharp
+        JAVA = :java
+        RUBY = :ruby
+        PHP = :php
+        GO = :go
+        RUST = :rust
+        KOTLIN = :kotlin
+        SWIFT = :swift
+        CPP = :cpp
+        DART = :dart
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/scalar_api_ruby/models/sdk_delete_params.rb

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

data/lib/scalar_api_ruby/models/sdk_list_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Sdks#list
+    class SdkListParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(limit: nil, request_options: {})
+      #   @param limit [Integer]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/sdk_list_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Sdks#list
+    class SdkListResponse < Scalar::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Scalar::Models::Sdk>]
+      required :data, -> { Scalar::Internal::Type::ArrayOf[Scalar::Sdk] }
+
+      # @!attribute has_more
+      #
+      #   @return [Boolean]
+      required :has_more, Scalar::Internal::Type::Boolean, api_name: :hasMore
+
+      # @!method initialize(data:, has_more:)
+      #   @param data [Array<Scalar::Models::Sdk>]
+      #   @param has_more [Boolean]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/sdk_retrieve_params.rb

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

data/lib/scalar_api_ruby/models/sdk_target_summary.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    class SdkTargetSummary < Scalar::Internal::Type::BaseModel
+      # @!attribute language
+      #
+      #   @return [Symbol, Scalar::Models::SdkTargetSummary::Language]
+      required :language, enum: -> { Scalar::SdkTargetSummary::Language }
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!method initialize(language:, slug:)
+      #   @param language [Symbol, Scalar::Models::SdkTargetSummary::Language]
+      #   @param slug [String]
+
+      # @see Scalar::Models::SdkTargetSummary#language
+      module Language
+        extend Scalar::Internal::Type::Enum
+
+        TYPESCRIPT = :typescript
+        PYTHON = :python
+        CLI = :cli
+        CSHARP = :csharp
+        JAVA = :java
+        RUBY = :ruby
+        PHP = :php
+        GO = :go
+        RUST = :rust
+        KOTLIN = :kotlin
+        SWIFT = :swift
+        CPP = :cpp
+        DART = :dart
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/scalar_api_ruby/models/sdk_update_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Sdks#update
+    class SdkUpdateParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute uid
+      #
+      #   @return [String]
+      required :uid, String
+
+      # @!attribute api_uid
+      #
+      #   @return [String, nil]
+      optional :api_uid, String, api_name: :apiUid, nil?: true
+
+      # @!attribute api_version
+      #
+      #   @return [String, nil]
+      optional :api_version, String, api_name: :apiVersion, nil?: true
+
+      # @!attribute config
+      #
+      #   @return [String, nil]
+      optional :config, String
+
+      # @!attribute is_private
+      #
+      #   @return [Boolean, nil]
+      optional :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate
+
+      # @!attribute slug
+      #
+      #   @return [String, nil]
+      optional :slug, String
+
+      # @!attribute title
+      #
+      #   @return [String, nil]
+      optional :title, String
+
+      # @!method initialize(uid:, api_uid: nil, api_version: nil, config: nil, is_private: nil, slug: nil, title: nil, request_options: {})
+      #   @param uid [String]
+      #   @param api_uid [String, nil]
+      #   @param api_version [String, nil]
+      #   @param config [String]
+      #   @param is_private [Boolean]
+      #   @param slug [String]
+      #   @param title [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/sdk_version.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    class SdkVersion < Scalar::Internal::Type::BaseModel
+      # @!attribute api_version
+      #
+      #   @return [String]
+      required :api_version, String, api_name: :apiVersion
+
+      # @!attribute languages
+      #
+      #   @return [Array<Symbol, Scalar::Models::SdkVersion::Language>]
+      required :languages, -> { Scalar::Internal::Type::ArrayOf[enum: Scalar::SdkVersion::Language] }
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Scalar::Models::SdkVersion::Status]
+      required :status, enum: -> { Scalar::SdkVersion::Status }
+
+      # @!attribute version
+      #
+      #   @return [String]
+      required :version, String
+
+      # @!attribute created_at
+      #
+      #   @return [Integer, nil]
+      optional :created_at, Integer, api_name: :createdAt
+
+      # @!attribute published_at
+      #
+      #   @return [Integer, nil]
+      optional :published_at, Integer, api_name: :publishedAt
+
+      # @!method initialize(api_version:, languages:, status:, version:, created_at: nil, published_at: nil)
+      #   @param api_version [String]
+      #   @param languages [Array<Symbol, Scalar::Models::SdkVersion::Language>]
+      #   @param status [Symbol, Scalar::Models::SdkVersion::Status]
+      #   @param version [String]
+      #   @param created_at [Integer]
+      #   @param published_at [Integer]
+
+      module Language
+        extend Scalar::Internal::Type::Enum
+
+        TYPESCRIPT = :typescript
+        PYTHON = :python
+        CLI = :cli
+        CSHARP = :csharp
+        JAVA = :java
+        RUBY = :ruby
+        PHP = :php
+        GO = :go
+        RUST = :rust
+        KOTLIN = :kotlin
+        SWIFT = :swift
+        CPP = :cpp
+        DART = :dart
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Scalar::Models::SdkVersion#status
+      module Status
+        extend Scalar::Internal::Type::Enum
+
+        DRAFT = :draft
+        PUBLISHED = :published
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/scalar_api_ruby/models/sdks/repository_link_params.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    module Sdks
+      # @see Scalar::Resources::Sdks::Repositories#link
+      class RepositoryLinkParams < Scalar::Internal::Type::BaseModel
+        extend Scalar::Internal::Type::RequestParameters::Converter
+        include Scalar::Internal::Type::RequestParameters
+
+        # @!attribute uid
+        #
+        #   @return [String]
+        required :uid, String
+
+        # @!attribute base_branch
+        #
+        #   @return [String]
+        required :base_branch, String, api_name: :baseBranch
+
+        # @!attribute language
+        #
+        #   @return [Symbol, Scalar::Models::Sdks::RepositoryLinkParams::Language]
+        required :language, enum: -> { Scalar::Sdks::RepositoryLinkParams::Language }
+
+        # @!attribute repository_id
+        #
+        #   @return [Integer]
+        required :repository_id, Integer, api_name: :repositoryId
+
+        # @!attribute prerelease_type
+        #
+        #   @return [String, nil]
+        optional :prerelease_type, String, api_name: :prereleaseType
+
+        # @!method initialize(uid:, base_branch:, language:, repository_id:, prerelease_type: nil, request_options: {})
+        #   @param uid [String]
+        #   @param base_branch [String]
+        #   @param language [Symbol, Scalar::Models::Sdks::RepositoryLinkParams::Language]
+        #   @param repository_id [Integer]
+        #   @param prerelease_type [String]
+        #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+
+        module Language
+          extend Scalar::Internal::Type::Enum
+
+          TYPESCRIPT = :typescript
+          PYTHON = :python
+          CLI = :cli
+          CSHARP = :csharp
+          JAVA = :java
+          RUBY = :ruby
+          PHP = :php
+          GO = :go
+          RUST = :rust
+          KOTLIN = :kotlin
+          SWIFT = :swift
+          CPP = :cpp
+          DART = :dart
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/scalar_api_ruby/models/sdks/repository_link_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    module Sdks
+      # @see Scalar::Resources::Sdks::Repositories#link
+      class RepositoryLinkResponse < Scalar::Internal::Type::BaseModel
+        # @!attribute branch
+        #
+        #   @return [String]
+        required :branch, String
+
+        # @!attribute repo
+        #
+        #   @return [String]
+        required :repo, String
+
+        # @!method initialize(branch:, repo:)
+        #   @param branch [String]
+        #   @param repo [String]
+      end
+    end
+  end
+end

data/lib/scalar_api_ruby/models/sdks/repository_unlink_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    module Sdks
+      # @see Scalar::Resources::Sdks::Repositories#unlink
+      class RepositoryUnlinkParams < Scalar::Internal::Type::BaseModel
+        extend Scalar::Internal::Type::RequestParameters::Converter
+        include Scalar::Internal::Type::RequestParameters
+
+        # @!attribute uid
+        #
+        #   @return [String]
+        required :uid, String
+
+        # @!attribute language
+        #
+        #   @return [Symbol, Scalar::Models::Sdks::RepositoryUnlinkParams::Language]
+        required :language, enum: -> { Scalar::Sdks::RepositoryUnlinkParams::Language }
+
+        # @!method initialize(uid:, language:, request_options: {})
+        #   @param uid [String]
+        #   @param language [Symbol, Scalar::Models::Sdks::RepositoryUnlinkParams::Language]
+        #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+
+        module Language
+          extend Scalar::Internal::Type::Enum
+
+          TYPESCRIPT = :typescript
+          PYTHON = :python
+          CLI = :cli
+          CSHARP = :csharp
+          JAVA = :java
+          RUBY = :ruby
+          PHP = :php
+          GO = :go
+          RUST = :rust
+          KOTLIN = :kotlin
+          SWIFT = :swift
+          CPP = :cpp
+          DART = :dart
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end