feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 7
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/hexlet%2Ftilda-d06441794bcf349b37439e4084aa5accb40ad16d553d5013cd33b9379f183dc1.yml
 openapi_spec_hash: 231389205a35d2d6c56bd1cac4091e81
-config_hash: 02a97d1e54040f9bd1eeef26fc735da7
+config_hash: 815230c382ea68d8cedd4946cdc9ef51

README.md

@@ -8,6 +8,8 @@ It is generated with [Stainless](https://www.stainless.com/).
 
 Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/tilda-ruby).
 
+The REST API documentation can be found on [help-ru.tilda.cc](https://help-ru.tilda.cc/api).
+
 ## Installation
 
 To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
@@ -26,13 +28,11 @@ gem "tilda-ruby", "~> 0.0.2"
 require "bundler/setup"
 require "tilda_ruby"
 
-tilda = TildaRuby::Client.new(
-  api_key: ENV["TILDA_API_KEY"] # This is the default and can be omitted
-)
+tilda = TildaRuby::Client.new(publickey: "My Publickey", secretkey: "My Secretkey")
 
-getpage = tilda.getpage.retrieve(pageid: "REPLACE_ME")
+projects = tilda.projects.list
 
-puts(getpage)
+puts(projects)
 ```
 
 ### Handling errors
@@ -41,7 +41,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  getpage = tilda.getpage.retrieve(pageid: "REPLACE_ME")
+  project = tilda.projects.list
 rescue TildaRuby::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -84,7 +84,7 @@ tilda = TildaRuby::Client.new(
 )
 
 # Or, configure per-request:
-tilda.getpage.retrieve(pageid: "REPLACE_ME", request_options: {max_retries: 5})
+tilda.projects.list(request_options: {max_retries: 5})
 ```
 
 ### Timeouts
@@ -98,7 +98,7 @@ tilda = TildaRuby::Client.new(
 )
 
 # Or, configure per-request:
-tilda.getpage.retrieve(pageid: "REPLACE_ME", request_options: {timeout: 5})
+tilda.projects.list(request_options: {timeout: 5})
 ```
 
 On timeout, `TildaRuby::Errors::APITimeoutError` is raised.
@@ -128,17 +128,16 @@ You can send undocumented parameters to any endpoint, and read undocumented resp
 Note: the `extra_` parameters of the same name overrides the documented parameters.
 
 ```ruby
-getpage =
-  tilda.getpage.retrieve(
-    pageid: "REPLACE_ME",
+projects =
+  tilda.projects.list(
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
       extra_headers: {"my-header": value}
     }
   )
 
-puts(getpage[:my_undocumented_property])
+puts(projects[:my_undocumented_property])
 ```
 
 #### Undocumented request params
@@ -176,18 +175,18 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-tilda.getpage.retrieve(pageid: "REPLACE_ME")
+tilda.projects.list
 ```
 
 Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-tilda.getpage.retrieve(pageid: "REPLACE_ME")
+tilda.projects.list
 
 # You can also splat a full Params class:
-params = TildaRuby::GetpageRetrieveParams.new(pageid: "REPLACE_ME")
-tilda.getpage.retrieve(**params)
+params = TildaRuby::ProjectListParams.new
+tilda.projects.list(**params)
 ```
 
 ## Versioning

lib/tilda_ruby.rb

@@ -52,27 +52,31 @@
 require_relative "tilda_ruby/internal/transport/base_client"
 require_relative "tilda_ruby/internal/transport/pooled_net_requester"
 require_relative "tilda_ruby/client"
-require_relative "tilda_ruby/models/error"
-require_relative "tilda_ruby/models/getpageexport_retrieve_params"
-require_relative "tilda_ruby/models/getpageexport_retrieve_response"
-require_relative "tilda_ruby/models/getpagefullexport_retrieve_params"
-require_relative "tilda_ruby/models/getpagefullexport_retrieve_response"
-require_relative "tilda_ruby/models/getpagefull_retrieve_params"
-require_relative "tilda_ruby/models/getpagefull_retrieve_response"
-require_relative "tilda_ruby/models/getpage_retrieve_params"
-require_relative "tilda_ruby/models/getpage_retrieve_response"
-require_relative "tilda_ruby/models/getpageslist_retrieve_params"
-require_relative "tilda_ruby/models/getpageslist_retrieve_response"
-require_relative "tilda_ruby/models/getprojectinfo_retrieve_params"
-require_relative "tilda_ruby/models/getprojectinfo_retrieve_response"
-require_relative "tilda_ruby/models/getprojectslist_list_params"
-require_relative "tilda_ruby/models/getprojectslist_list_response"
+require_relative "tilda_ruby/models/css_asset"
+require_relative "tilda_ruby/models/export_retrieve_full_params"
+require_relative "tilda_ruby/models/export_retrieve_full_response"
+require_relative "tilda_ruby/models/export_retrieve_params"
+require_relative "tilda_ruby/models/export_retrieve_response"
 require_relative "tilda_ruby/models/image_mapping"
+require_relative "tilda_ruby/models/js_asset"
+require_relative "tilda_ruby/models/page_body"
+require_relative "tilda_ruby/models/page_export_body"
+require_relative "tilda_ruby/models/page_export_full"
+require_relative "tilda_ruby/models/page_full"
+require_relative "tilda_ruby/models/page_list_params"
+require_relative "tilda_ruby/models/page_list_response"
+require_relative "tilda_ruby/models/page_retrieve_full_params"
+require_relative "tilda_ruby/models/page_retrieve_full_response"
+require_relative "tilda_ruby/models/page_retrieve_params"
+require_relative "tilda_ruby/models/page_retrieve_response"
+require_relative "tilda_ruby/models/page_summary"
+require_relative "tilda_ruby/models/project_info"
+require_relative "tilda_ruby/models/project_list_item"
+require_relative "tilda_ruby/models/project_list_params"
+require_relative "tilda_ruby/models/project_list_response"
+require_relative "tilda_ruby/models/project_retrieve_params"
+require_relative "tilda_ruby/models/project_retrieve_response"
 require_relative "tilda_ruby/models"
-require_relative "tilda_ruby/resources/getpage"
-require_relative "tilda_ruby/resources/getpageexport"
-require_relative "tilda_ruby/resources/getpagefull"
-require_relative "tilda_ruby/resources/getpagefullexport"
-require_relative "tilda_ruby/resources/getpageslist"
-require_relative "tilda_ruby/resources/getprojectinfo"
-require_relative "tilda_ruby/resources/getprojectslist"
+require_relative "tilda_ruby/resources/export"
+require_relative "tilda_ruby/resources/pages"
+require_relative "tilda_ruby/resources/projects"

lib/tilda_ruby/client.rb

@@ -15,42 +15,49 @@ class Client < TildaRuby::Internal::Transport::BaseClient
     # Default max retry delay in seconds.
     DEFAULT_MAX_RETRY_DELAY = 8.0
 
+    # Tilda API public key
     # @return [String, nil]
-    attr_reader :api_key
+    attr_reader :publickey
 
-    # @return [TildaRuby::Resources::Getpage]
-    attr_reader :getpage
-
-    # @return [TildaRuby::Resources::Getpageexport]
-    attr_reader :getpageexport
-
-    # @return [TildaRuby::Resources::Getpagefull]
-    attr_reader :getpagefull
+    # Tilda API secret key
+    # @return [String, nil]
+    attr_reader :secretkey
 
-    # @return [TildaRuby::Resources::Getpagefullexport]
-    attr_reader :getpagefullexport
+    # @return [TildaRuby::Resources::Projects]
+    attr_reader :projects
 
-    # @return [TildaRuby::Resources::Getpageslist]
-    attr_reader :getpageslist
+    # @return [TildaRuby::Resources::Pages]
+    attr_reader :pages
 
-    # @return [TildaRuby::Resources::Getprojectinfo]
-    attr_reader :getprojectinfo
+    # @return [TildaRuby::Resources::Export]
+    attr_reader :export
 
-    # @return [TildaRuby::Resources::Getprojectslist]
-    attr_reader :getprojectslist
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_query
+      {**public_key_auth, **secret_key_auth}
+    end
 
     # @api private
     #
     # @return [Hash{String=>String}]
-    private def auth_headers
-      return {} if @api_key.nil?
+    private def public_key_auth
+      {"publickey" => @publickey}
+    end
 
-      {"authorization" => "Bearer #{@api_key}"}
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def secret_key_auth
+      {"secretkey" => @secretkey}
     end
 
     # Creates and returns a new client for interacting with the API.
     #
-    # @param api_key [String, nil] Defaults to `ENV["TILDA_API_KEY"]`
+    # @param publickey [String, nil] Tilda API public key
+    #
+    # @param secretkey [String, nil] Tilda API secret key
     #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["TILDA_BASE_URL"]`
@@ -63,7 +70,8 @@ class Client < TildaRuby::Internal::Transport::BaseClient
     #
     # @param max_retry_delay [Float]
     def initialize(
-      api_key: ENV["TILDA_API_KEY"],
+      publickey: nil,
+      secretkey: nil,
       base_url: ENV["TILDA_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
@@ -72,7 +80,8 @@ def initialize(
     )
       base_url ||= "https://api.tildacdn.info"
 
-      @api_key = api_key&.to_s
+      @publickey = publickey&.to_s
+      @secretkey = secretkey&.to_s
 
       super(
         base_url: base_url,
@@ -82,13 +91,9 @@ def initialize(
         max_retry_delay: max_retry_delay
       )
 
-      @getpage = TildaRuby::Resources::Getpage.new(client: self)
-      @getpageexport = TildaRuby::Resources::Getpageexport.new(client: self)
-      @getpagefull = TildaRuby::Resources::Getpagefull.new(client: self)
-      @getpagefullexport = TildaRuby::Resources::Getpagefullexport.new(client: self)
-      @getpageslist = TildaRuby::Resources::Getpageslist.new(client: self)
-      @getprojectinfo = TildaRuby::Resources::Getprojectinfo.new(client: self)
-      @getprojectslist = TildaRuby::Resources::Getprojectslist.new(client: self)
+      @projects = TildaRuby::Resources::Projects.new(client: self)
+      @pages = TildaRuby::Resources::Pages.new(client: self)
+      @export = TildaRuby::Resources::Export.new(client: self)
     end
   end
 end

lib/tilda_ruby/internal/transport/base_client.rb

@@ -218,7 +218,7 @@ def initialize(
         # @api private
         #
         # @return [Hash{String=>String}]
-        private def auth_headers = {}
+        private def auth_query = {}
 
         # @api private
         #
@@ -272,11 +272,10 @@ def initialize(
 
           path = TildaRuby::Internal::Util.interpolate_path(uninterpolated_path)
 
-          query = TildaRuby::Internal::Util.deep_merge(req[:query].to_h, opts[:extra_query].to_h)
+          query = TildaRuby::Internal::Util.deep_merge(auth_query, req[:query].to_h, opts[:extra_query].to_h)
 
           headers = TildaRuby::Internal::Util.normalized_headers(
             @headers,
-            auth_headers,
             req[:headers].to_h,
             opts[:extra_headers].to_h
           )

lib/tilda_ruby/internal/type/base_model.rb

@@ -438,10 +438,10 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false)
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `error` is a `TildaRuby::Error`
-        #   error => {
-        #     status: status,
-        #     message: message
+        #   # `image_mapping` is a `TildaRuby::ImageMapping`
+        #   image_mapping => {
+        #     from: from,
+        #     to: to
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

lib/tilda_ruby/internal/type/union.rb

@@ -6,14 +6,14 @@ module Type
       # @api private
       #
       # @example
-      #   # `getpage_retrieve_response` is a `TildaRuby::Models::GetpageRetrieveResponse`
-      #   case getpage_retrieve_response
-      #   when TildaRuby::Models::GetpageRetrieveResponse::UnionMember0
-      #     puts(getpage_retrieve_response.result)
-      #   when TildaRuby::Error
-      #     puts(getpage_retrieve_response.status)
+      #   # `project_retrieve_response` is a `TildaRuby::Models::ProjectRetrieveResponse`
+      #   case project_retrieve_response
+      #   when TildaRuby::Models::ProjectRetrieveResponse::UnionMember0
+      #     puts(project_retrieve_response.result)
+      #   when TildaRuby::Models::ProjectRetrieveResponse::ErrorResponse
+      #     puts(project_retrieve_response.status)
       #   else
-      #     puts(getpage_retrieve_response)
+      #     puts(project_retrieve_response)
       #   end
       module Union
         include TildaRuby::Internal::Type::Converter

lib/tilda_ruby/models.rb

@@ -39,21 +39,37 @@ module TildaRuby
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
-  Error = TildaRuby::Models::Error
+  CssAsset = TildaRuby::Models::CssAsset
 
-  GetpageexportRetrieveParams = TildaRuby::Models::GetpageexportRetrieveParams
+  ExportRetrieveFullParams = TildaRuby::Models::ExportRetrieveFullParams
 
-  GetpagefullexportRetrieveParams = TildaRuby::Models::GetpagefullexportRetrieveParams
+  ExportRetrieveParams = TildaRuby::Models::ExportRetrieveParams
 
-  GetpagefullRetrieveParams = TildaRuby::Models::GetpagefullRetrieveParams
+  ImageMapping = TildaRuby::Models::ImageMapping
 
-  GetpageRetrieveParams = TildaRuby::Models::GetpageRetrieveParams
+  JsAsset = TildaRuby::Models::JsAsset
 
-  GetpageslistRetrieveParams = TildaRuby::Models::GetpageslistRetrieveParams
+  PageBody = TildaRuby::Models::PageBody
 
-  GetprojectinfoRetrieveParams = TildaRuby::Models::GetprojectinfoRetrieveParams
+  PageExportBody = TildaRuby::Models::PageExportBody
 
-  GetprojectslistListParams = TildaRuby::Models::GetprojectslistListParams
+  PageExportFull = TildaRuby::Models::PageExportFull
 
-  ImageMapping = TildaRuby::Models::ImageMapping
+  PageFull = TildaRuby::Models::PageFull
+
+  PageListParams = TildaRuby::Models::PageListParams
+
+  PageRetrieveFullParams = TildaRuby::Models::PageRetrieveFullParams
+
+  PageRetrieveParams = TildaRuby::Models::PageRetrieveParams
+
+  PageSummary = TildaRuby::Models::PageSummary
+
+  ProjectInfo = TildaRuby::Models::ProjectInfo
+
+  ProjectListItem = TildaRuby::Models::ProjectListItem
+
+  ProjectListParams = TildaRuby::Models::ProjectListParams
+
+  ProjectRetrieveParams = TildaRuby::Models::ProjectRetrieveParams
 end

lib/tilda_ruby/models/css_asset.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module TildaRuby
+  module Models
+    class CssAsset < TildaRuby::Internal::Type::BaseModel
+      # @!attribute from
+      #
+      #   @return [String]
+      required :from, String
+
+      # @!attribute to
+      #
+      #   @return [String]
+      required :to, String
+
+      # @!method initialize(from:, to:)
+      #   @param from [String]
+      #   @param to [String]
+    end
+  end
+end