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/users/users.rb CHANGED

@@ -1,78 +1,124 @@
-require_relative 'alternate_emails'
-module Smartsheet
-  # Users Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#users API Users Docs
-  #
-  # @!attribute [r] alternate_emails
-  #   @return [AlternateEmails]
-  class Users
-    attr_reader :client, :alternate_emails
-    private :client
-    def initialize(client)
-      @client = client
-      @alternate_emails = AlternateEmails.new(client)
-    end
-    def add(body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['users'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          body: body,
-          params: params
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get_current(params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users', 'me'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get(user_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users', :user_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          user_id: user_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def list(params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def remove(user_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['users', :user_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          user_id: user_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def update(user_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['users', :user_id], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          user_id: user_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+require_relative 'alternate_emails'
+module Smartsheet
+  # Users Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#users API Users Docs
+  #
+  # @!attribute [r] alternate_emails
+  #   @return [AlternateEmails]
+  class Users
+    attr_reader :client, :alternate_emails
+    private :client
+    def initialize(client)
+      @client = client
+      @alternate_emails = AlternateEmails.new(client)
+    end
+    def add(body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['users'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          body: body,
+          params: params
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get_current(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users', 'me'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get(user_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users', :user_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          user_id: user_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def list(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['users'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def remove(user_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['users', :user_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          user_id: user_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def update(user_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['users', :user_id], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          user_id: user_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def add_profile_image(
+        user_id:,
+        file:,
+        filename:,
+        file_length:,
+        content_type: '',
+        params: {},
+        header_overrides: {}
+    )
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['users', :user_id, 'profileimage'],
+          body_type: :file
+      )
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          file_spec: Smartsheet::API::ObjectFileSpec.new(file, filename, file_length, content_type),
+          user_id: user_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def add_profile_image_from_path(
+        user_id:,
+        path:,
+        filename: nil,
+        content_type: '',
+        params: {},
+        header_overrides: {}
+    )
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['users', :user_id, 'profileimage'],
+          body_type: :file
+      )
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          file_spec: Smartsheet::API::PathFileSpec.new(path, filename, content_type),
+          user_id: user_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end

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

@@ -1,72 +1,72 @@
-module Smartsheet
-  # Webhooks Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#webhooks-reference API Webhooks Docs
-  class Webhooks
-    attr_reader :client
-    private :client
-    def initialize(client)
-      @client = client
-    end
-    def create(body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['webhooks'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def delete(webhook_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['webhooks', :webhook_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          webhook_id: webhook_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get(webhook_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['webhooks', :webhook_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          webhook_id: webhook_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def list(params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['webhooks'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def reset_shared_secret(webhook_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['webhooks', :webhook_id, 'resetsharedsecret'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          webhook_id: webhook_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def update(webhook_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['webhooks', :webhook_id], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          webhook_id: webhook_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+module Smartsheet
+  # Webhooks Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#webhooks-reference API Webhooks Docs
+  class Webhooks
+    attr_reader :client
+    private :client
+    def initialize(client)
+      @client = client
+    end
+    def create(body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['webhooks'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def delete(webhook_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['webhooks', :webhook_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          webhook_id: webhook_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get(webhook_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['webhooks', :webhook_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          webhook_id: webhook_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def list(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['webhooks'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def reset_shared_secret(webhook_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['webhooks', :webhook_id, 'resetsharedsecret'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          webhook_id: webhook_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def update(webhook_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:put, ['webhooks', :webhook_id], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          webhook_id: webhook_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end

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

@@ -1,88 +1,88 @@
-require_relative 'workspaces_share'
-module Smartsheet
-  # Workspaces Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#workspaces API Workspaces Docs
-  #
-  # @!attribute [r] share
-  #   @return [WorkspacesShare]
-  class Workspaces
-    attr_reader :client, :share
-    private :client
-    def initialize(client)
-      @client = client
-      @share = WorkspacesShare.new(client)
-    end
-    def copy(workspace_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(
-          :post,
-          ['workspaces', :workspace_id, 'copy'],
-          body_type: :json
-      )
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          body: body,
-          workspace_id: workspace_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def create(body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['workspaces'], body_type: :json)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def delete(workspace_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['workspaces', :workspace_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          workspace_id: workspace_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def get(workspace_id:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['workspaces', :workspace_id])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          workspace_id: workspace_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def list(params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['workspaces'])
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-    def update(workspace_id:, body:, params: {}, header_overrides: {})
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(
-          :put,
-          ['workspaces', :workspace_id],
-          body_type: :json
-      )
-      request_spec = Smartsheet::API::RequestSpec.new(
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          workspace_id: workspace_id
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+require_relative 'workspaces_share'
+module Smartsheet
+  # Workspaces Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#workspaces API Workspaces Docs
+  #
+  # @!attribute [r] share
+  #   @return [WorkspacesShare]
+  class Workspaces
+    attr_reader :client, :share
+    private :client
+    def initialize(client)
+      @client = client
+      @share = WorkspacesShare.new(client)
+    end
+    def copy(workspace_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['workspaces', :workspace_id, 'copy'],
+          body_type: :json
+      )
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          body: body,
+          workspace_id: workspace_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def create(body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['workspaces'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def delete(workspace_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:delete, ['workspaces', :workspace_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          workspace_id: workspace_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def get(workspace_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['workspaces', :workspace_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          workspace_id: workspace_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def list(params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['workspaces'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+    def update(workspace_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :put,
+          ['workspaces', :workspace_id],
+          body_type: :json
+      )
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          workspace_id: workspace_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end