files.com 1.1.507 → 1.1.509

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58b3c1c4a7063b048568d17bf2ccbfe348a6f5839227da92bb7f913ed71e8500
-  data.tar.gz: f67199d5a928bb050cc3fe4b511a236d26c2d6efe0613747d9aae34417fd4c9d
+  metadata.gz: dc094b4519d6ec153e40bc70a30569d40fa3339ad24c48b4d4c92179d6502110
+  data.tar.gz: c7e82f44a2a0a6fea5e2c3c6aca2068470210547be4b2b0222977dbf9befef25
 SHA512:
-  metadata.gz: b15cd9123f65e14e3095a06e89c008ef79f03633ea10e5f72611f85ab26960815e8d136ad17162690af6fc0834fc4a11c66ef64b8afa72991ac406b24e6e9a69
-  data.tar.gz: aca25e15fb486669276bda4e1fda7f5f95ee37983fa0ee7e221a1389803d10dc8570a1c19a9093d23dd8b022f9a4262dd024a3c74b570bcbe9618beab1816f5a
+  metadata.gz: 38edfbb5bb3597ca7b180b9bdb95fbccd34d0c39567a4a2d81ce6955b3a9568b76011690d8aabbff54e5f1a725e45e66095d7bedc40880140d9fb26c8b7bc614
+  data.tar.gz: 7543ca5d2447538607f545523347c20e914589044c6b4fb15ea48cdbf94704d592e0d9a0b20498d979026f2a06d98bc64c35d22033fa6a40ed8826a8b7d8c8cc

data/README.md

@@ -476,6 +476,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`CantMoveWithMultipleLocationsError`|  `BadRequestError` |
 |`DatetimeParseError`|  `BadRequestError` |
 |`DestinationSameError`|  `BadRequestError` |
+|`DestinationSiteMismatchError`|  `BadRequestError` |
 |`DoesNotSupportSortingError`|  `BadRequestError` |
 |`FolderMustNotBeAFileError`|  `BadRequestError` |
 |`FoldersNotAllowedError`|  `BadRequestError` |

data/_VERSION

@@ -1 +1 @@
-1.1.507
+1.1.509

data/docs/bundle.md

@@ -154,7 +154,7 @@ Files::Bundle.list(
 * `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 * `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
-* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
+* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, created_at ]` and `[ user_id, expires_at ]`.
 * `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
 * `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
 * `filter_prefix` (object): If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.

data/docs/partner_site_request.md

@@ -0,0 +1,154 @@
+# PartnerSiteRequest
+
+## Example PartnerSiteRequest Object
+
+```
+{
+  "id": 1,
+  "partner_id": 1,
+  "linked_site_id": 1,
+  "status": "pending",
+  "pairing_key": "abc123xyz",
+  "created_at": "2000-01-01T01:00:00Z",
+  "updated_at": "2000-01-01T01:00:00Z"
+}
+```
+
+* `id` (int64): Partner Site Request ID
+* `partner_id` (int64): Partner ID
+* `linked_site_id` (int64): Linked Site ID
+* `status` (string): Request status (pending, approved, rejected)
+* `pairing_key` (string): Pairing key used to approve this request on the target site
+* `created_at` (date-time): Request creation date/time
+* `updated_at` (date-time): Request last updated date/time
+* `site_url` (string): Site URL to link to
+
+
+---
+
+## List Partner Site Requests
+
+```
+Files::PartnerSiteRequest.list
+```
+
+### Parameters
+
+* `cursor` (string): Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+
+
+---
+
+## Find partner site request by pairing key
+
+```
+Files::PartnerSiteRequest.find_by_pairing_key(
+  pairing_key: "pairing_key"
+)
+```
+
+### Parameters
+
+* `pairing_key` (string): Required - Pairing key for the partner site request
+
+
+---
+
+## Create Partner Site Request
+
+```
+Files::PartnerSiteRequest.create(
+  partner_id: 1, 
+  site_url: "site_url"
+)
+```
+
+### Parameters
+
+* `partner_id` (int64): Required - Partner ID to link with
+* `site_url` (string): Required - Site URL to link to
+
+
+---
+
+## Reject partner site request
+
+```
+Files::PartnerSiteRequest.reject(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Partner Site Request ID.
+
+
+---
+
+## Approve partner site request
+
+```
+Files::PartnerSiteRequest.approve(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Partner Site Request ID.
+
+
+---
+
+## Delete Partner Site Request
+
+```
+Files::PartnerSiteRequest.delete(id)
+```
+
+### Parameters
+
+* `id` (int64): Required - Partner Site Request ID.
+
+
+---
+
+## Reject partner site request
+
+```
+partner_site_request = Files::PartnerSiteRequest.list.first
+
+partner_site_request.reject
+```
+
+### Parameters
+
+* `id` (int64): Required - Partner Site Request ID.
+
+
+---
+
+## Approve partner site request
+
+```
+partner_site_request = Files::PartnerSiteRequest.list.first
+
+partner_site_request.approve
+```
+
+### Parameters
+
+* `id` (int64): Required - Partner Site Request ID.
+
+
+---
+
+## Delete Partner Site Request
+
+```
+partner_site_request = Files::PartnerSiteRequest.list.first
+
+partner_site_request.delete
+```
+
+### Parameters
+
+* `id` (int64): Required - Partner Site Request ID.

data/lib/files.com/errors.rb

@@ -52,6 +52,7 @@ module Files
   class CantMoveWithMultipleLocationsError < BadRequestError; end
   class DatetimeParseError < BadRequestError; end
   class DestinationSameError < BadRequestError; end
+  class DestinationSiteMismatchError < BadRequestError; end
   class DoesNotSupportSortingError < BadRequestError; end
   class FolderMustNotBeAFileError < BadRequestError; end
   class FoldersNotAllowedError < BadRequestError; end

data/lib/files.com/models/bundle.rb

@@ -531,7 +531,7 @@ module Files
     #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
     #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
     #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `expires_at`.
-    #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, expires_at ]`.
+    #   filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `expires_at`, `code` or `user_id`. Valid field combinations are `[ user_id, created_at ]` and `[ user_id, expires_at ]`.
     #   filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at` and `expires_at`.
     #   filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at` and `expires_at`.
     #   filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code`.

data/lib/files.com/models/partner_site_request.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Files
+  class PartnerSiteRequest
+    attr_reader :options, :attributes
+
+    def initialize(attributes = {}, options = {})
+      @attributes = attributes || {}
+      @options = options || {}
+    end
+
+    # int64 - Partner Site Request ID
+    def id
+      @attributes[:id]
+    end
+
+    def id=(value)
+      @attributes[:id] = value
+    end
+
+    # int64 - Partner ID
+    def partner_id
+      @attributes[:partner_id]
+    end
+
+    def partner_id=(value)
+      @attributes[:partner_id] = value
+    end
+
+    # int64 - Linked Site ID
+    def linked_site_id
+      @attributes[:linked_site_id]
+    end
+
+    def linked_site_id=(value)
+      @attributes[:linked_site_id] = value
+    end
+
+    # string - Request status (pending, approved, rejected)
+    def status
+      @attributes[:status]
+    end
+
+    def status=(value)
+      @attributes[:status] = value
+    end
+
+    # string - Pairing key used to approve this request on the target site
+    def pairing_key
+      @attributes[:pairing_key]
+    end
+
+    def pairing_key=(value)
+      @attributes[:pairing_key] = value
+    end
+
+    # date-time - Request creation date/time
+    def created_at
+      @attributes[:created_at]
+    end
+
+    # date-time - Request last updated date/time
+    def updated_at
+      @attributes[:updated_at]
+    end
+
+    # string - Site URL to link to
+    def site_url
+      @attributes[:site_url]
+    end
+
+    def site_url=(value)
+      @attributes[:site_url] = value
+    end
+
+    # Reject partner site request
+    def reject(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/partner_site_requests/#{@attributes[:id]}/reject", :post, params, @options)
+    end
+
+    # Approve partner site request
+    def approve(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/partner_site_requests/#{@attributes[:id]}/approve", :post, params, @options)
+    end
+
+    def delete(params = {})
+      params ||= {}
+      params[:id] = @attributes[:id]
+      raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/partner_site_requests/#{@attributes[:id]}", :delete, params, @options)
+    end
+
+    def destroy(params = {})
+      delete(params)
+      nil
+    end
+
+    def save
+      if @attributes[:id]
+        raise NotImplementedError.new("The PartnerSiteRequest object doesn't support updates.")
+      else
+        new_obj = PartnerSiteRequest.create(@attributes, @options)
+      end
+
+      @attributes = new_obj.attributes
+      true
+    end
+
+    # Parameters:
+    #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
+    #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+    def self.list(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params[:cursor] and !params[:cursor].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params[:per_page] and !params[:per_page].is_a?(Integer)
+
+      List.new(PartnerSiteRequest, params) do
+        Api.send_request("/partner_site_requests", :get, params, options)
+      end
+    end
+
+    def self.all(params = {}, options = {})
+      list(params, options)
+    end
+
+    # Parameters:
+    #   pairing_key (required) - string - Pairing key for the partner site request
+    def self.find_by_pairing_key(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: pairing_key must be an String") if params[:pairing_key] and !params[:pairing_key].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: pairing_key") unless params[:pairing_key]
+
+      Api.send_request("/partner_site_requests/find_by_pairing_key", :get, params, options)
+      nil
+    end
+
+    # Parameters:
+    #   partner_id (required) - int64 - Partner ID to link with
+    #   site_url (required) - string - Site URL to link to
+    def self.create(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
+      raise InvalidParameterError.new("Bad parameter: site_url must be an String") if params[:site_url] and !params[:site_url].is_a?(String)
+      raise MissingParameterError.new("Parameter missing: partner_id") unless params[:partner_id]
+      raise MissingParameterError.new("Parameter missing: site_url") unless params[:site_url]
+
+      response, options = Api.send_request("/partner_site_requests", :post, params, options)
+      PartnerSiteRequest.new(response.data, options)
+    end
+
+    # Reject partner site request
+    def self.reject(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/partner_site_requests/#{params[:id]}/reject", :post, params, options)
+      nil
+    end
+
+    # Approve partner site request
+    def self.approve(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/partner_site_requests/#{params[:id]}/approve", :post, params, options)
+      nil
+    end
+
+    def self.delete(id, params = {}, options = {})
+      params ||= {}
+      params[:id] = id
+      raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params[:id] and !params[:id].is_a?(Integer)
+      raise MissingParameterError.new("Parameter missing: id") unless params[:id]
+
+      Api.send_request("/partner_site_requests/#{params[:id]}", :delete, params, options)
+      nil
+    end
+
+    def self.destroy(id, params = {}, options = {})
+      delete(id, params, options)
+      nil
+    end
+  end
+end

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.507"
+  VERSION = "1.1.509"
 end

data/lib/files.com.rb

@@ -100,6 +100,7 @@ require "files.com/models/message_reaction"
 require "files.com/models/notification"
 require "files.com/models/outbound_connection_log"
 require "files.com/models/partner"
+require "files.com/models/partner_site_request"
 require "files.com/models/payment"
 require "files.com/models/payment_line_item"
 require "files.com/models/permission"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.507
+  version: 1.1.509
 platform: ruby
 authors:
 - files.com
@@ -225,6 +225,7 @@ files:
 - docs/notification.md
 - docs/outbound_connection_log.md
 - docs/partner.md
+- docs/partner_site_request.md
 - docs/payment.md
 - docs/payment_line_item.md
 - docs/permission.md
@@ -344,6 +345,7 @@ files:
 - lib/files.com/models/notification.rb
 - lib/files.com/models/outbound_connection_log.rb
 - lib/files.com/models/partner.rb
+- lib/files.com/models/partner_site_request.rb
 - lib/files.com/models/payment.rb
 - lib/files.com/models/payment_line_item.rb
 - lib/files.com/models/permission.rb