files.com 1.0.1 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 891d58e7e3d98bb4f267ba5b81383f32ce5faf08a84cc3d1881094ccde5186a0
-  data.tar.gz: e19353b0cb333d0cf3795d453a502f50dc106629dd98eba0444ba437394f984e
+  metadata.gz: e6ed2e7925095b07ea7eadda809546db49cb0262d96adb84dd6d95406dd44b48
+  data.tar.gz: e491b852fb8e049e543726f258d3e6226ab0980ceb0ff58bfe33b39bdcd5aa84
 SHA512:
-  metadata.gz: aba59d36146a7f7c33ffb6d4f47ea68064c7d5611d93be4c693213c81dd6417681eb3b44ae21076db933772c0504e4fa05fe817843779503542fa9edee3d7301
-  data.tar.gz: b5de315a3c897a98c4a3faaa059076a48cb5389b4f9a3001e691cc435be4c7fa6c59373935ff9e1cfe7fd7300742d68aed5f171bf408f6043bf0edcb912cc19d
+  metadata.gz: fad0d792249da16c7e507347955ecec5850e8d79d4a07f914571f8d20d798e18209cba1a27e9a138e92b1bfd27e0301d8c49993b6d4be63fd75c201643051b37
+  data.tar.gz: b069cf3593af5d36375e99bea512e1398247e57e35a1ff913750b406daef18c603b5f12057d9ed08ce5a7d9619b5527a30023baa89d997ac382b2c3a923ffdd4

data/CONTRIBUTORS

@@ -1,4 +1,2 @@
 Kevin Bombino <kevin.bombino@files.com>
 Martyn Garcia <martyn.garcia@files.com>
-Dustin Zeisler <dustin.zeisler@files.com>
-Rommel Santor <rommel.santor@files.com>

data/Gemfile

@@ -3,10 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'memory_profiler'
   gem 'pry'
   gem 'pry-byebug'
   gem 'rake', '~> 12.0.0'
-  gem 'rspec', '~> 3.9.0'
-  gem 'rubocop'
+  gem 'rspec'
 end

data/Gemfile.lock

@@ -1,44 +1,26 @@
 PATH
   remote: .
   specs:
-    files.com (1.0)
-      addressable (>= 2.7.0)
-      concurrent-ruby (>= 1.1.3)
-      faraday (>= 1.0.1)
-      net-http-persistent
+    files.com (1.0.0)
+      faraday
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
-    byebug (11.1.3)
+    byebug (11.0.1)
     coderay (1.1.2)
-    concurrent-ruby (1.1.6)
-    connection_pool (2.2.3)
     diff-lcs (1.3)
-    faraday (1.0.1)
+    faraday (1.0.0)
       multipart-post (>= 1.2, < 3)
-    memory_profiler (0.9.14)
-    method_source (1.0.0)
+    method_source (0.9.2)
     multipart-post (2.1.1)
-    net-http-persistent (4.0.0)
-      connection_pool (~> 2.2)
-    parallel (1.19.2)
-    parser (2.7.1.4)
-      ast (~> 2.4.1)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
-    public_suffix (4.0.5)
-    rainbow (3.0.0)
+      pry (~> 0.10)
     rake (12.0.0)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -51,32 +33,17 @@ GEM
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.85.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.0.3)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.7.0)
+    rspec-support (3.9.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   files.com!
-  memory_profiler
   pry
   pry-byebug
   rake (~> 12.0.0)
-  rspec (~> 3.9.0)
-  rubocop
+  rspec
 
 BUNDLED WITH
-   2.1.4
+   2.0.2

data/README.md

@@ -65,9 +65,7 @@ You can set the following global options directly on the `Files` module:
  * `Files.log_level` - set to `nil`, `info`, or `debug`
  * `Files.open_timeout` - open timeout in seconds (default: 30)
  * `Files.read_timeout` - read timeout in seconds (default: 80)
- * `Files.initial_network_retry_delay` - initial retry delay in seconds (default: 0.5)
  * `Files.max_network_retries` - max retries (default: 3)
- * `Files.max_network_retry_delay` - max retry delay in seconds (default: 2)
  * `Files.base_url` - to point this client at an on-premise
    installation of Files.com, set its URL here.
  * `Files.proxy` - proxy configuration (uses Faraday format)
@@ -81,12 +79,12 @@ word Folder, not Dir, and Files::Dir is simply an alias for
 Files::Folder).
 
 
-#### List root folder
+#### List using array syntax example
 
-    Files::Folder.list_for("/").each do |file|
-      puts file.path
+    Files::Dir["/"].each do |path|
+      puts path
     end
-    
+
 
 #### Writing a file example
 

data/_VERSION

@@ -1 +1 @@
-1.0.1
+1.0.7

data/docs/account.md

@@ -0,0 +1,87 @@
+# Account
+
+## Example Account Object
+
+```
+{
+  "name": "account",
+  "address": "123 Main St",
+  "address_2": "Window 1",
+  "card_number": "xxxxxxxxxxxx1234",
+  "card_type": "Visa",
+  "city": "New York",
+  "company_name": "Action Verb",
+  "country": "US",
+  "created_at": "2000-01-01 01:00:00 UTC",
+  "currency": "USD",
+  "email": "john.doe@files.com",
+  "phone_number": "555-555-5555",
+  "processor_type": "Credit Card",
+  "state": "NY",
+  "updated_at": "2000-01-01 01:00:00 UTC",
+  "zip": "00000",
+  "billing_frequency": 1
+}
+```
+
+* `name` (string): Account name
+* `address` (string): Account address
+* `address_2` (string): Account address 2
+* `card_number` (string): Account payment card number
+* `card_type` (string): Account payment card type
+* `city` (string): Account city
+* `company_name` (string): Account company name
+* `country` (string): Account country
+* `created_at` (date-time): Account creation date/time
+* `currency` (string): Account preferred currency
+* `email` (email): Account email address
+* `phone_number` (string): Account phone number
+* `processor_type` (string): Type of billing processor.  Can be PayPal, Credit Card, or Manual
+* `state` (string): Account state
+* `updated_at` (date-time): Account last updated at
+* `zip` (string): Account zipcode
+* `billing_frequency` (int64): Account billing frequency.  Either 12(yearly) or 1(monthly)
+
+
+---
+
+## Internal hidden endpoint.  Subject to change.  Not for public consumption
+
+```
+Files::Account.update(
+  name: "account", 
+  company_name: "Action Verb", 
+  address: "123 Main St", 
+  address_2: "Window 1", 
+  city: "New York", 
+  state: "NY", 
+  zip: "00000", 
+  country: "US", 
+  email: "john.doe@files.com", 
+  phone_number: "555-555-5555", 
+  card_number: "xxxxxxxxxxxx1234", 
+  card_type: "Visa"
+)
+```
+
+### Parameters
+
+* `name` (string): Internal name.
+* `company_name` (string): Company name.
+* `address` (string): Address line 1.
+* `address_2` (string): Address line 2.
+* `city` (string): City.
+* `state` (string): State.
+* `zip` (string): Zipcode.
+* `country` (string): Country.
+* `email` (string): Email.
+* `phone_number` (string): Primary phone number.
+* `card_number` (string): Credit card number.
+* `card_type` (string): Credit card type.  Can be visa, master, maestro, solo, switch, american_express, or discover.
+* `expiration_year` (string): Expiration year(4 digits).
+* `expiration_month` (string): Expiration month(2 digits).
+* `start_year` (string): Required for some cards(Switch / Solo).
+* `start_month` (string): Required for some cards(Switch / Solo).
+* `cvv` (string): 3 digit code on the back of the card.
+* `paypal_token` (string): Token for paying with paypal.
+* `paypal_payer_id` (string): Paypal payer ID for paying with paypal.

data/docs/account_line_item.md

@@ -4,12 +4,12 @@
 
 ```
 {
-  "id": 1,
   "amount": "",
   "balance": "",
-  "created_at": "2000-01-01T01:00:00Z",
+  "created_at": "2000-01-01 01:00:00 UTC",
   "currency": "USD",
   "download_uri": "https://url...",
+  "id": 1,
   "invoice_line_items": [
 
   ],
@@ -17,20 +17,20 @@
   "payment_line_items": [
 
   ],
-  "payment_reversed_at": "2000-01-01T01:00:00Z",
+  "payment_reversed_at": "2000-01-01 01:00:00 UTC",
   "payment_type": "",
   "site_name": "My Site",
   "type": "invoice",
-  "updated_at": "2000-01-01T01:00:00Z"
+  "updated_at": "2000-01-01 01:00:00 UTC"
 }
 ```
 
-* `id` (int64): Line item Id
-* `amount` (double): Line item amount
-* `balance` (double): Line item balance
+* `amount` (float): Line item amount
+* `balance` (float): Line item balance
 * `created_at` (date-time): Line item created at
 * `currency` (string): Line item currency
 * `download_uri` (string): Line item download uri
+* `id` (int64): Line item Id
 * `invoice_line_items` (array): Associated invoice line items
 * `method` (string): Line item payment method
 * `payment_line_items` (array): Associated payment line items

data/docs/action.md

@@ -5,11 +5,11 @@
 ```
 {
   "id": 1,
-  "path": "path",
-  "when": "2000-01-01T01:00:00Z",
+  "when": "2000-01-01 01:00:00 UTC",
   "destination": "/to_path",
-  "display": "Actual text of the action here.",
+  "display": "full",
   "ip": "192.283.128.182",
+  "path": "path",
   "source": "/from_path",
   "targets": [
 
@@ -23,11 +23,11 @@
 ```
 
 * `id` (int64): Action ID
-* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `when` (date-time): Action occurrence date/time
 * `destination` (string): The destination path for this action, if applicable
-* `display` (string): Friendly displayed output
+* `display` (string): Display format
 * `ip` (string): IP Address that performed this action
+* `path` (string): Path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
 * `source` (string): The source path for this action, if applicable
 * `targets` (array): Targets
 * `user_id` (int64): User ID

data/docs/announcement.md

@@ -0,0 +1,45 @@
+# Announcement
+
+## Example Announcement Object
+
+```
+{
+  "body": "This is the body.",
+  "button_text": "View Blog Post",
+  "button_url": "https://www.files.com/blog/",
+  "headline": "Files.com Now Supports In-App Announcements!",
+  "html_body": "<p>This is the HTML version of the body.</p>",
+  "label": "New Feature",
+  "label_color": "#000000",
+  "publish_at": "2000-01-01 01:00:00 UTC",
+  "slug": "new-feature"
+}
+```
+
+* `body` (string): Announcement body
+* `button_text` (string): Text to go on the CTA button
+* `button_url` (string): URL to link to when CTA button is clicked
+* `headline` (string): Announcement headline
+* `html_body` (string): Body converted to HTML
+* `label` (string): Text for a label that can be added to the announcement
+* `label_color` (string): Color for label on announcement
+* `publish_at` (date-time): When was this announcement published?
+* `slug` (string): URL slug for announcement
+
+
+---
+
+## List in-app announcements that are shown in the header of the UI
+
+```
+Files::Announcement.list(
+  page: 1, 
+  per_page: 1
+)
+```
+
+### Parameters
+
+* `page` (int64): Current page number.
+* `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
+* `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.

data/docs/api_key.md

@@ -5,11 +5,9 @@
 ```
 {
   "id": 1,
-  "descriptive_label": "Site-wide API key for https://site.files.com/ (key ID #1)",
-  "created_at": "2000-01-01T01:00:00Z",
-  "expires_at": "2000-01-01T01:00:00Z",
+  "created_at": "2000-01-01 01:00:00 UTC",
+  "expires_at": "2000-01-01 01:00:00 UTC",
   "key": "[key]",
-  "last_use_at": "2000-01-01T01:00:00Z",
   "name": "My Main API Key",
   "permission_set": "full",
   "platform": "win32",
@@ -18,11 +16,9 @@
 ```
 
 * `id` (int64): API Key ID
-* `descriptive_label` (string): Unique label that describes this API key.  Useful for external systems where you may have API keys from multiple accounts and want a human-readable label for each key.
 * `created_at` (date-time): Time which API Key was created
 * `expires_at` (date-time): API Key expiration date
 * `key` (string): API Key actual key string
-* `last_use_at` (date-time): API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
 * `name` (string): Internal name for the API Key.  For your use.
 * `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations.)  We hope to offer additional permission sets in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 * `platform` (string): If this API key represents a Desktop app, what platform was it created on?
@@ -43,21 +39,12 @@ Files::ApiKey.list(
 
 ### Parameters
 
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `user_id` (int64): User ID. If not provided, this operation will operate on your own user.
 * `page` (int64): Current page number.
 * `per_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 * `action` (string): Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
 
 
----
-
-## Show information about current API key.  (Requires current API connection to be using an API key.)
-
-```
-Files::ApiKey.find_current
-```
-
-
 ---
 
 ## Show Api Key
@@ -80,13 +67,13 @@ Files::ApiKey.create(
   user_id: 1, 
   name: "My Key", 
   permission_set: "full", 
-  expires_at: "2000-01-01T01:00:00Z"
+  expires_at: "2000-01-01 01:00:00 UTC"
 )
 ```
 
 ### Parameters
 
-* `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
+* `user_id` (int64): User ID. If not provided, this operation will operate on your own user.
 * `name` (string): Internal name for key.  For your reference only.
 * `permission_set` (string): Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
 * `expires_at` (string): Have the key expire at this date/time.
@@ -97,10 +84,10 @@ Files::ApiKey.create(
 ## Update current API key.  (Requires current API connection to be using an API key.)
 
 ```
-Files::ApiKey.update_current(
+Files::ApiKey.update(
   name: "My Key", 
   permission_set: "full", 
-  expires_at: "2000-01-01T01:00:00Z"
+  expires_at: "2000-01-01 01:00:00 UTC"
 )
 ```
 
@@ -111,59 +98,25 @@ Files::ApiKey.update_current(
 * `expires_at` (string): Have the key expire at this date/time.
 
 
----
-
-## Update Api Key
-
-```
-Files::ApiKey.update(id, 
-  name: "My Key", 
-  permission_set: "full", 
-  expires_at: "2000-01-01T01:00:00Z"
-)
-```
-
-### Parameters
-
-* `id` (int64): Required - Api Key ID.
-* `name` (string): Internal name for key.  For your reference only.
-* `permission_set` (string): Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
-* `expires_at` (string): Have the key expire at this date/time.
-
-
 ---
 
 ## Delete current API key.  (Requires current API connection to be using an API key.)
 
 ```
-Files::ApiKey.delete_current
+Files::ApiKey.delete
 ```
 
 
----
-
-## Delete Api Key
-
-```
-Files::ApiKey.delete(id)
-```
-
-### Parameters
-
-* `id` (int64): Required - Api Key ID.
-
-
 ---
 
 ## Update Api Key
 
 ```
-api_key = Files::ApiKey.list_for(path).first
-
+api_key = Files::ApiKey.find(1)
 api_key.update(
   name: "My Key",
   permission_set: "full",
-  expires_at: "2000-01-01T01:00:00Z"
+  expires_at: "2000-01-01 01:00:00 UTC"
 )
 ```
 
@@ -180,8 +133,7 @@ api_key.update(
 ## Delete Api Key
 
 ```
-api_key = Files::ApiKey.list_for(path).first
-
+api_key = Files::ApiKey.find(1)
 api_key.delete
 ```