RubyGems - smartsheet - Versions diffs - 2.77.0 → 2.101.1 - Mend

smartsheet 2.77.0 → 2.101.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (73) hide show

checksums.yaml +4 -4
data/.gitignore +12 -12
data/.rubocop.yml +4 -4
data/.travis.yml +29 -15
data/.yardopts +3 -3
data/ADVANCED.md +78 -78
data/CHANGELOG.md +133 -112
data/Gemfile +6 -6
data/LICENSE +202 -202
data/README.md +248 -246
data/Rakefile +29 -29
data/bin/console +14 -14
data/bin/setup +8 -8
data/lib/smartsheet.rb +2 -2
data/lib/smartsheet/api/body_builder.rb +25 -25
data/lib/smartsheet/api/endpoint_spec.rb +54 -54
data/lib/smartsheet/api/faraday_adapter/faraday_net_client.rb +45 -45
data/lib/smartsheet/api/faraday_adapter/faraday_response.rb +70 -70
data/lib/smartsheet/api/faraday_adapter/middleware/faraday_error_translator.rb +20 -20
data/lib/smartsheet/api/faraday_adapter/middleware/response_parser.rb +25 -25
data/lib/smartsheet/api/file_spec.rb +55 -55
data/lib/smartsheet/api/header_builder.rb +96 -96
data/lib/smartsheet/api/request.rb +42 -42
data/lib/smartsheet/api/request_client.rb +43 -43
data/lib/smartsheet/api/request_logger.rb +182 -182
data/lib/smartsheet/api/request_spec.rb +57 -57
data/lib/smartsheet/api/response_net_client_decorator.rb +54 -54
data/lib/smartsheet/api/retry_logic.rb +40 -40
data/lib/smartsheet/api/retry_net_client_decorator.rb +37 -37
data/lib/smartsheet/api/url_builder.rb +25 -25
data/lib/smartsheet/client.rb +193 -193
data/lib/smartsheet/constants.rb +18 -18
data/lib/smartsheet/endpoints/contacts/contacts.rb +30 -30
data/lib/smartsheet/endpoints/events/events.rb +20 -20
data/lib/smartsheet/endpoints/favorites/favorites.rb +159 -159
data/lib/smartsheet/endpoints/folders/folders.rb +125 -125
data/lib/smartsheet/endpoints/groups/groups.rb +83 -83
data/lib/smartsheet/endpoints/home/home.rb +20 -20
data/lib/smartsheet/endpoints/reports/reports.rb +100 -100
data/lib/smartsheet/endpoints/reports/reports_share.rb +69 -69
data/lib/smartsheet/endpoints/search/search.rb +30 -30
data/lib/smartsheet/endpoints/server_info/server_info.rb +21 -21
data/lib/smartsheet/endpoints/share/share.rb +58 -58
data/lib/smartsheet/endpoints/sheets/automation_rules.rb +55 -55
data/lib/smartsheet/endpoints/sheets/cells.rb +82 -82
data/lib/smartsheet/endpoints/sheets/columns.rb +66 -66
data/lib/smartsheet/endpoints/sheets/comments.rb +64 -64
data/lib/smartsheet/endpoints/sheets/comments_attachments.rb +78 -78
data/lib/smartsheet/endpoints/sheets/cross_sheet_references.rb +45 -45
data/lib/smartsheet/endpoints/sheets/discussions.rb +84 -84
data/lib/smartsheet/endpoints/sheets/discussions_attachments.rb +22 -22
data/lib/smartsheet/endpoints/sheets/rows.rb +106 -106
data/lib/smartsheet/endpoints/sheets/rows_attachments.rb +92 -92
data/lib/smartsheet/endpoints/sheets/sheets.rb +514 -510
data/lib/smartsheet/endpoints/sheets/sheets_attachments.rb +174 -174
data/lib/smartsheet/endpoints/sheets/sheets_share.rb +69 -69
data/lib/smartsheet/endpoints/sheets/sheets_summaries.rb +123 -0
data/lib/smartsheet/endpoints/sights/sights.rb +101 -101
data/lib/smartsheet/endpoints/sights/sights_share.rb +69 -69
data/lib/smartsheet/endpoints/templates/templates.rb +29 -29
data/lib/smartsheet/endpoints/token/token.rb +70 -66
data/lib/smartsheet/endpoints/update_requests/sent_update_requests.rb +44 -44
data/lib/smartsheet/endpoints/update_requests/update_requests.rb +74 -74
data/lib/smartsheet/endpoints/users/alternate_emails.rb +79 -79
data/lib/smartsheet/endpoints/users/users.rb +123 -77
data/lib/smartsheet/endpoints/webhooks/webhooks.rb +71 -71
data/lib/smartsheet/endpoints/workspaces/workspaces.rb +87 -87
data/lib/smartsheet/endpoints/workspaces/workspaces_share.rb +70 -70
data/lib/smartsheet/error.rb +69 -69
data/lib/smartsheet/general_request.rb +74 -74
data/lib/smartsheet/version.rb +5 -5
data/smartsheet.gemspec +54 -54
metadata +24 -12

data/lib/smartsheet/endpoints/reports/reports.rb CHANGED

@@ -1,101 +1,101 @@
-require 'smartsheet/constants'
-require_relative 'reports_share'
-module Smartsheet
-  # Reports Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#reports API Reports Docs
-  #
-  # @!attribute [r] share
-  #   @return [ReportsShare]
-  class Reports
-    include Smartsheet::Constants
-    attr_reader :client, :share
-    private :client
-    def initialize(client)
-      @client = client
-      @share = ReportsShare.new(client)
-    end
-    def get(report_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['reports', :report_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          report_id: report_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get_as_excel(report_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(
-          :get,
-          ['reports', :report_id],
-          headers: {Accept: EXCEL_TYPE}
-      )
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          report_id: report_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get_as_csv(report_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(
-          :get,
-          ['reports', :report_id],
-          headers: {Accept: CSV_TYPE})
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          report_id: report_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def list(params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['reports'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get_publish_status(report_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['reports', :report_id, 'publish'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          report_id: report_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def set_publish_status(report_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['reports', :report_id, 'publish'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          report_id: report_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def send_via_email(report_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['reports', :report_id, 'emails'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          report_id: report_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+require 'smartsheet/constants'
+require_relative 'reports_share'
+module Smartsheet
+  # Reports Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#reports API Reports Docs
+  #
+  # @!attribute [r] share
+  #   @return [ReportsShare]
+  class Reports
+    include Smartsheet::Constants
+    attr_reader :client, :share
+    private :client
+    def initialize(client)
+      @client = client
+      @share = ReportsShare.new(client)
+    end
+    def get(report_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['reports', :report_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          report_id: report_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get_as_excel(report_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :get,
+          ['reports', :report_id],
+          headers: {Accept: EXCEL_TYPE}
+      )
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          report_id: report_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get_as_csv(report_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :get,
+          ['reports', :report_id],
+          headers: {Accept: CSV_TYPE})
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          report_id: report_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def list(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['reports'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get_publish_status(report_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['reports', :report_id, 'publish'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          report_id: report_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def set_publish_status(report_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['reports', :report_id, 'publish'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          report_id: report_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def send_via_email(report_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['reports', :report_id, 'emails'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          report_id: report_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end

data/lib/smartsheet/endpoints/reports/reports_share.rb CHANGED

@@ -1,70 +1,70 @@
-require 'smartsheet/endpoints/share/share'
-module Smartsheet
-  # Report Sharing Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#report-sharing API Report Sharing Docs
-  class ReportsShare
-    attr_reader :client
-    private :client
-    URL = ['reports', :report_id].freeze
-    def initialize(client)
-      @client = client
-    end
-    def delete(report_id:, share_id:, params: {}, header_overrides: {})
-      delete_share(
-          share_id: share_id,
-          url: URL,
-          params: params,
-          header_overrides: header_overrides,
-          report_id: report_id
-      )
-    end
-    def get(report_id:, share_id:, params: {}, header_overrides: {})
-      get_share(
-          share_id: share_id,
-          url: URL,
-          params: params,
-          header_overrides: header_overrides,
-          report_id: report_id
-      )
-    end
-    def list(report_id:, params: {}, header_overrides: {})
-      list_share(
-          url: URL,
-          header_overrides: header_overrides,
-          params: params,
-          report_id: report_id
-      )
-    end
-    def create(report_id:, body:, params: {}, header_overrides: {})
-      create_share(
-          url: URL,
-          header_overrides: header_overrides,
-          params: params,
-          body: body,
-          report_id: report_id
-      )
-    end
-    def update(report_id:, share_id:, body:, params: {}, header_overrides: {})
-      update_share(
-          share_id: share_id,
-          url: URL,
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          report_id: report_id
-      )
-    end
-    private
-    include Smartsheet::Share
-  end
+require 'smartsheet/endpoints/share/share'
+module Smartsheet
+  # Report Sharing Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#report-sharing API Report Sharing Docs
+  class ReportsShare
+    attr_reader :client
+    private :client
+    URL = ['reports', :report_id].freeze
+    def initialize(client)
+      @client = client
+    end
+    def delete(report_id:, share_id:, params: {}, header_overrides: {})
+      delete_share(
+          share_id: share_id,
+          url: URL,
+          params: params,
+          header_overrides: header_overrides,
+          report_id: report_id
+      )
+    end
+    def get(report_id:, share_id:, params: {}, header_overrides: {})
+      get_share(
+          share_id: share_id,
+          url: URL,
+          params: params,
+          header_overrides: header_overrides,
+          report_id: report_id
+      )
+    end
+    def list(report_id:, params: {}, header_overrides: {})
+      list_share(
+          url: URL,
+          header_overrides: header_overrides,
+          params: params,
+          report_id: report_id
+      )
+    end
+    def create(report_id:, body:, params: {}, header_overrides: {})
+      create_share(
+          url: URL,
+          header_overrides: header_overrides,
+          params: params,
+          body: body,
+          report_id: report_id
+      )
+    end
+    def update(report_id:, share_id:, body:, params: {}, header_overrides: {})
+      update_share(
+          share_id: share_id,
+          url: URL,
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          report_id: report_id
+      )
+    end
+    private
+    include Smartsheet::Share
+  end
 end

data/lib/smartsheet/endpoints/search/search.rb CHANGED

@@ -1,31 +1,31 @@
-module Smartsheet
-  # Search Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#search API Search Docs
-  class Search
-    attr_reader :client
-    private :client
-    def initialize(client)
-      @client = client
-    end
-    def search_all(query:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['search'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params.merge({query: query})
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def search_sheet(sheet_id:, query:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['search', 'sheets', :sheet_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params.merge({query: query}),
-          sheet_id: sheet_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+module Smartsheet
+  # Search Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#search API Search Docs
+  class Search
+    attr_reader :client
+    private :client
+    def initialize(client)
+      @client = client
+    end
+    def search_all(query:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['search'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params.merge({query: query})
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def search_sheet(sheet_id:, query:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['search', 'sheets', :sheet_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params.merge({query: query}),
+          sheet_id: sheet_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end

data/lib/smartsheet/endpoints/server_info/server_info.rb CHANGED

@@ -1,22 +1,22 @@
-module Smartsheet
-  # Server Information Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#server-information API Server
-  #   Information Docs
-  class ServerInfo
-    attr_reader :client
-    private :client
-    def initialize(client)
-      @client = client
-    end
-    def get(params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['serverinfo'], no_auth: true)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+module Smartsheet
+  # Server Information Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#server-information API Server
+  #   Information Docs
+  class ServerInfo
+    attr_reader :client
+    private :client
+    def initialize(client)
+      @client = client
+    end
+    def get(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['serverinfo'], no_auth: true)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end

data/lib/smartsheet/endpoints/share/share.rb CHANGED

@@ -1,59 +1,59 @@
-module Smartsheet
-  # Sharing Endpoints Mixin
-  module Share
-    def delete_share(share_id:, url:, params:, header_overrides:, **url_args)
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, url + ['shares', :share_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          share_id: share_id,
-          **url_args
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get_share(share_id:, url:, params:, header_overrides:, **url_args)
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, url + ['shares', :share_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          share_id: share_id,
-          **url_args
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def list_share(url:, params:, header_overrides:, **url_args)
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, url + ['shares'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          **url_args
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def create_share(url:, body:, params:, header_overrides:, **url_args)
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, url + ['shares'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          body: body,
-          **url_args
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def update_share(share_id:, url:, body:, params:, header_overrides:, **url_args)
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, url + ['shares', :share_id], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          share_id: share_id,
-          **url_args
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+module Smartsheet
+  # Sharing Endpoints Mixin
+  module Share
+    def delete_share(share_id:, url:, params:, header_overrides:, **url_args)
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, url + ['shares', :share_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          share_id: share_id,
+          **url_args
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get_share(share_id:, url:, params:, header_overrides:, **url_args)
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, url + ['shares', :share_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          share_id: share_id,
+          **url_args
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def list_share(url:, params:, header_overrides:, **url_args)
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, url + ['shares'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          **url_args
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def create_share(url:, body:, params:, header_overrides:, **url_args)
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, url + ['shares'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          body: body,
+          **url_args
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def update_share(share_id:, url:, body:, params:, header_overrides:, **url_args)
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, url + ['shares', :share_id], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          share_id: share_id,
+          **url_args
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end