connectwise-ruby-sdk 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67365aa2854f003f880b8c827d65e2d2183eff97
-  data.tar.gz: 0e4d40ec6fc74f26949e7264d93e954637900a09
+  metadata.gz: 693dac62ab48c81c4fc9486069d42c9df66915a3
+  data.tar.gz: b5eb248ae134808659738091df5512eb28356612
 SHA512:
-  metadata.gz: 2737476272003e3c5a97e767816472f909d7ce276eaeb5458d978aacfa396cb893764fc17e9c1c8882e0ff94747da61e65d3fdb6a3fb07ddf7917d4bdb89377a
-  data.tar.gz: 5868f60606b66161d561862b722dac6daaff854e6723738faef315ebdafff2cab651172f84925bf8580912a77ad250074c39e8af966339acd976aa50310332dc
+  metadata.gz: '008e558815ed949b735f5dd5b3d2add15b692606adb794b559a584ad5a767b726a001e3007868983af887b24092e8052e1f4821b19607b2cb994bc6da414ff01'
+  data.tar.gz: 33521b2b1bbb216cf190ed6979428f4830d450ec5f4664144e974df7ffc4f9a13ff441233c5ce0f261fcdc8c14279e174e6b05cc9685dd7570ea9f4f26071160

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'rake'
+end

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {yyyy} {name of copyright owner}
+   Copyright 2016 Cameron Sowder
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,15 +1,17 @@
 # connectwise-ruby-sdk
+ [![Build Status](https://travis-ci.org/sowderca/connectwise-ruby-sdk.svg?branch=master)](https://travis-ci.org/sowderca/connectwise-ruby-sdk) 
+ [![Dependency Status](https://gemnasium.com/badges/github.com/sowderca/connectwise-ruby-sdk.svg)](https://gemnasium.com/github.com/sowderca/connectwise-ruby-sdk)
+ [![Gem Version](https://badge.fury.io/rb/connectwise-ruby-sdk.svg)](https://badge.fury.io/rb/connectwise-ruby-sdk)
+[![Gem](https://img.shields.io/gem/dt/connectwise-ruby-sdk.svg)](https://rubygems.org/gems/connectwise-ruby-sdk)
 
-Connectwise - the Ruby gem for the Connectwise REST API
-
-ConnectWise API
+connectwise-ruby-sdk - the Ruby gem for the Connectwise REST API
 
 ## Installation
 
 Then either install the gem locally:
 
 ```shell
-gem install ./connectwise-ruby-sdk-1.0.2
+gem install connectwise-ruby-sdk-1.0.2
 ```
 
 Or install from [RubyGems](https://rubygems.org/).
@@ -20,7 +22,7 @@ Add this to the Gemfile:
 ```
 ### Install from Git
 ```ruby
-    gem 'connectwise-ruby-sdk', :git => 'https://github.com/vc3/connectwise-rest-api'
+    gem 'connectwise-ruby-sdk', :git => 'https://github.com/sowderca/connectwise-ruby-sdk'
 ```
 ### Include the Ruby code directly
 
@@ -40,8 +42,11 @@ require 'connectwise-ruby-sdk'
 # Setup authorization
 Connectwise.configure do |config|
   # Configure HTTP basic authorization: BasicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
+  config.username = 'USERNAME' # in the form of company_id+public_api_key
+  config.password = 'PASSWORD' # private_api_key
+  config.host = 'URL' # your connectwise url
+  config.base_path = '/v4_6_release/apis/3.0'
+  config.scheme = 'https'
 end
 
 api_instance = Connectwise::AccountingBatchTransactionsApi.new

data/Rakefile

@@ -0,0 +1,6 @@
+# encoding: utf-8
+desc "Run specs"
+task(:test) {
+  ruby "-S rspec"
+}
+task :default => :test

data/docs/DocumentsApi.md

@@ -314,16 +314,15 @@ record_type = "record_type_example" # String | Entity type
 
 title = "title_example" # String | Document title
 
-url = "url_example" # String | Document url
-
 opts = { 
-  file: File.new("/path/to/file.txt"), # File | File to upload
+  url: "//path/to/file", # String | Url of file to attach
+  file: File.open("/path/to/file.txt"), # File | File to upload
   private_flag: true, # BOOLEAN | Indicates if document is private
   read_only_flag: true # BOOLEAN | Indicates if document is readonly
 }
 
 begin
-  result = api_instance.system_documents_id_post(id, record_id, record_type, title, url, opts)
+  result = api_instance.system_documents_id_post(id, record_id, record_type, title, opts)
   p result
 rescue Connectwise::ApiError => e
   puts "Exception when calling DocumentsApi->system_documents_id_post: #{e}"
@@ -338,8 +337,8 @@ Name | Type | Description  | Notes
  **record_id** | **Integer**| Entity id | 
  **record_type** | **String**| Entity type | 
  **title** | **String**| Document title | 
- **url** | **String**| Document url | 
- **file** | **File**| File to upload | [optional] 
+ **url** | **String**| Document url | [optional if file present]
+ **file** | **File**| File to upload | [optional if url present] 
  **private_flag** | **BOOLEAN**| Indicates if document is private | [optional] 
  **read_only_flag** | **BOOLEAN**| Indicates if document is readonly | [optional] 
 
@@ -384,16 +383,15 @@ record_type = "record_type_example" # String | Entity type
 
 title = "title_example" # String | Document title
 
-url = "url_example" # String | Document url
-
 opts = { 
-  file: File.new("/path/to/file.txt"), # File | File to upload
+  url: "//path/to/file", # String | Document url
+  file: File.open("/path/to/file.txt"), # File | File to upload
   private_flag: true, # BOOLEAN | Indicates if document is private
   read_only_flag: true # BOOLEAN | Indicates if document is readonly
 }
 
 begin
-  result = api_instance.system_documents_post(record_id, record_type, title, url, opts)
+  result = api_instance.system_documents_post(record_id, record_type, title, opts)
   p result
 rescue Connectwise::ApiError => e
   puts "Exception when calling DocumentsApi->system_documents_post: #{e}"

data/lib/connectwise-ruby-sdk/api/documents_api.rb

@@ -31,22 +31,22 @@ module Connectwise
       @api_client = api_client
     end
 
-    # 
+    #
     # Get Documents Info Count
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :record_type 
-    # @option opts [Integer] :record_id 
+    # @option opts [String] :record_type
+    # @option opts [Integer] :record_id
     # @return [Count]
     def system_documents_count_get(opts = {})
       data, _status_code, _headers = system_documents_count_get_with_http_info(opts)
       return data
     end
 
-    # 
+    #
     # Get Documents Info Count
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :record_type 
-    # @option opts [Integer] :record_id 
+    # @option opts [String] :record_type
+    # @option opts [Integer] :record_id
     # @return [Array<(Count, Fixnum, Hash)>] Count data, response status code and response headers
     def system_documents_count_get_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -93,26 +93,26 @@ module Connectwise
       return data, status_code, headers
     end
 
-    # 
+    #
     # Get Documents Info
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :record_type 
-    # @option opts [Integer] :record_id 
-    # @option opts [Integer] :page 
-    # @option opts [Integer] :page_size 
+    # @option opts [String] :record_type
+    # @option opts [Integer] :record_id
+    # @option opts [Integer] :page
+    # @option opts [Integer] :page_size
     # @return [Array<DocumentInfo>]
     def system_documents_get(opts = {})
       data, _status_code, _headers = system_documents_get_with_http_info(opts)
       return data
     end
 
-    # 
+    #
     # Get Documents Info
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :record_type 
-    # @option opts [Integer] :record_id 
-    # @option opts [Integer] :page 
-    # @option opts [Integer] :page_size 
+    # @option opts [String] :record_type
+    # @option opts [Integer] :record_id
+    # @option opts [Integer] :page
+    # @option opts [Integer] :page_size
     # @return [Array<(Array<DocumentInfo>, Fixnum, Hash)>] Array<DocumentInfo> data, response status code and response headers
     def system_documents_get_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -161,9 +161,9 @@ module Connectwise
       return data, status_code, headers
     end
 
-    # 
+    #
     # Delete Document Info By Id
-    # @param id 
+    # @param id
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def system_documents_id_delete(id, opts = {})
@@ -171,9 +171,9 @@ module Connectwise
       return nil
     end
 
-    # 
+    #
     # Delete Document Info By Id
-    # @param id 
+    # @param id
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def system_documents_id_delete_with_http_info(id, opts = {})
@@ -217,22 +217,22 @@ module Connectwise
       return data, status_code, headers
     end
 
-    # 
+    #
     # Download Document
-    # @param id 
+    # @param id
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :last_modified 
+    # @option opts [String] :last_modified
     # @return [nil]
     def system_documents_id_download_get(id, opts = {})
       system_documents_id_download_get_with_http_info(id, opts)
       return nil
     end
 
-    # 
+    #
     # Download Document
-    # @param id 
+    # @param id
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :last_modified 
+    # @option opts [String] :last_modified
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
     def system_documents_id_download_get_with_http_info(id, opts = {})
       if @api_client.config.debugging
@@ -276,9 +276,9 @@ module Connectwise
       return data, status_code, headers
     end
 
-    # 
+    #
     # Get Document Info By Id
-    # @param id 
+    # @param id
     # @param [Hash] opts the optional parameters
     # @return [DocumentInfo]
     def system_documents_id_get(id, opts = {})
@@ -286,9 +286,9 @@ module Connectwise
       return data
     end
 
-    # 
+    #
     # Get Document Info By Id
-    # @param id 
+    # @param id
     # @param [Hash] opts the optional parameters
     # @return [Array<(DocumentInfo, Fixnum, Hash)>] DocumentInfo data, response status code and response headers
     def system_documents_id_get_with_http_info(id, opts = {})
@@ -333,36 +333,36 @@ module Connectwise
       return data, status_code, headers
     end
 
-    # 
+    #
     # Update Document By Id
-    # @param id 
+    # @param id
     # @param record_id Entity id
     # @param record_type Entity type
     # @param title Document title
-    # @param url Document url
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :url Document url
     # @option opts [File] :file File to upload
     # @option opts [BOOLEAN] :private_flag Indicates if document is private
     # @option opts [BOOLEAN] :read_only_flag Indicates if document is readonly
     # @return [DocumentInfo]
-    def system_documents_id_post(id, record_id, record_type, title, url, opts = {})
-      data, _status_code, _headers = system_documents_id_post_with_http_info(id, record_id, record_type, title, url, opts)
+    def system_documents_id_post(id, record_id, record_type, title, opts = {})
+      data, _status_code, _headers = system_documents_id_post_with_http_info(id, record_id, record_type, title, opts)
       return data
     end
 
-    # 
+    #
     # Update Document By Id
-    # @param id 
+    # @param id
     # @param record_id Entity id
     # @param record_type Entity type
     # @param title Document title
-    # @param url Document url
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :url Document url
     # @option opts [File] :file File to upload
     # @option opts [BOOLEAN] :private_flag Indicates if document is private
     # @option opts [BOOLEAN] :read_only_flag Indicates if document is readonly
     # @return [Array<(DocumentInfo, Fixnum, Hash)>] DocumentInfo data, response status code and response headers
-    def system_documents_id_post_with_http_info(id, record_id, record_type, title, url, opts = {})
+    def system_documents_id_post_with_http_info(id, record_id, record_type, title, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: DocumentsApi.system_documents_id_post ..."
       end
@@ -382,9 +382,9 @@ module Connectwise
         fail ArgumentError, 'invalid value for "title" when calling DocumentsApi.system_documents_id_post, the character length must be smaller than or equal to 100.'
       end
 
-      # verify the required parameter 'url' is set
-      fail ArgumentError, "Missing the required parameter 'url' when calling DocumentsApi.system_documents_id_post" if url.nil?
-      if url.to_s.length > 500
+      # verify the required parameter 'url' or 'file' is set
+      fail ArgumentError, "Missing the required options 'url' or 'file' when calling DocumentsApi.system_documents_id_post" if opts[:url].nil? && opts[:file].nil?
+      if opts[:url] && opts[:url].to_s.length > 500
         fail ArgumentError, 'invalid value for "url" when calling DocumentsApi.system_documents_id_post, the character length must be smaller than or equal to 500.'
       end
 
@@ -410,7 +410,7 @@ module Connectwise
       form_params["recordId"] = record_id
       form_params["recordType"] = record_type
       form_params["title"] = title
-      form_params["url"] = url
+      form_params["url"] = opts[:url] unless opts[:url].nil?
       form_params["file"] = opts[:'file'] if !opts[:'file'].nil?
       form_params["privateFlag"] = opts[:'private_flag'] if !opts[:'private_flag'].nil?
       form_params["readOnlyFlag"] = opts[:'read_only_flag'] if !opts[:'read_only_flag'].nil?
@@ -431,34 +431,34 @@ module Connectwise
       return data, status_code, headers
     end
 
-    # 
+    #
     # Insert Document
     # @param record_id Entity id
     # @param record_type Entity type
     # @param title Document title
-    # @param url Document url
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :url Document url
     # @option opts [File] :file File to upload
     # @option opts [BOOLEAN] :private_flag Indicates if document is private
     # @option opts [BOOLEAN] :read_only_flag Indicates if document is readonly
     # @return [DocumentInfo]
-    def system_documents_post(record_id, record_type, title, url, opts = {})
-      data, _status_code, _headers = system_documents_post_with_http_info(record_id, record_type, title, url, opts)
+    def system_documents_post(record_id, record_type, title, opts = {})
+      data, _status_code, _headers = system_documents_post_with_http_info(record_id, record_type, title, opts)
       return data
     end
 
-    # 
+    #
     # Insert Document
     # @param record_id Entity id
     # @param record_type Entity type
     # @param title Document title
-    # @param url Document url
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :url Document url
     # @option opts [File] :file File to upload
     # @option opts [BOOLEAN] :private_flag Indicates if document is private
     # @option opts [BOOLEAN] :read_only_flag Indicates if document is readonly
     # @return [Array<(DocumentInfo, Fixnum, Hash)>] DocumentInfo data, response status code and response headers
-    def system_documents_post_with_http_info(record_id, record_type, title, url, opts = {})
+    def system_documents_post_with_http_info(record_id, record_type, title, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: DocumentsApi.system_documents_post ..."
       end
@@ -476,10 +476,10 @@ module Connectwise
         fail ArgumentError, 'invalid value for "title" when calling DocumentsApi.system_documents_post, the character length must be smaller than or equal to 100.'
       end
 
-      # verify the required parameter 'url' is set
-      fail ArgumentError, "Missing the required parameter 'url' when calling DocumentsApi.system_documents_post" if url.nil?
-      if url.to_s.length > 500
-        fail ArgumentError, 'invalid value for "url" when calling DocumentsApi.system_documents_post, the character length must be smaller than or equal to 500.'
+      # verify the required parameter 'url' or 'file' is set
+      fail ArgumentError, "Missing the required options 'url' or 'file' when calling DocumentsApi.system_documents_id_post" if opts[:url].nil? && opts[:file].nil?
+      if opts[:url] && opts[:url].to_s.length > 500
+        fail ArgumentError, 'invalid value for "url" when calling DocumentsApi.system_documents_id_post, the character length must be smaller than or equal to 500.'
       end
 
       # resource path
@@ -504,7 +504,7 @@ module Connectwise
       form_params["recordId"] = record_id
       form_params["recordType"] = record_type
       form_params["title"] = title
-      form_params["url"] = url
+      form_params["url"] = opts[:url] unless opts[:url].nil?
       form_params["file"] = opts[:'file'] if !opts[:'file'].nil?
       form_params["privateFlag"] = opts[:'private_flag'] if !opts[:'private_flag'].nil?
       form_params["readOnlyFlag"] = opts[:'read_only_flag'] if !opts[:'read_only_flag'].nil?
@@ -525,7 +525,7 @@ module Connectwise
       return data, status_code, headers
     end
 
-    # 
+    #
     # Get Upload Sample Page
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -534,7 +534,7 @@ module Connectwise
       return nil
     end
 
-    # 
+    #
     # Get Upload Sample Page
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

data/lib/connectwise-ruby-sdk/version.rb

@@ -22,5 +22,5 @@ limitations under the License.
 =end
 
 module Connectwise
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: connectwise-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Cameron Sowder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-05 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -197,8 +197,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - connectwise-ruby-sdk.gemspec
 - docs/AccountingBatchTransactionsApi.md
 - docs/AccountingBatchesApi.md