spartera_api_sdk 1.0.58

data/docs/UsersApi.md

@@ -0,0 +1,357 @@
+# SparteraApiSdk::UsersApi
+
+All URIs are relative to *https://api.spartera.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**companies_company_id_users_get**](UsersApi.md#companies_company_id_users_get) | **GET** /companies/{company_id}/users | Get a list of all users for a particular company |
+| [**companies_company_id_users_post**](UsersApi.md#companies_company_id_users_post) | **POST** /companies/{company_id}/users | Create a new user |
+| [**companies_company_id_users_user_id_delete**](UsersApi.md#companies_company_id_users_user_id_delete) | **DELETE** /companies/{company_id}/users/{user_id} | Delete single user by ID |
+| [**companies_company_id_users_user_id_get**](UsersApi.md#companies_company_id_users_user_id_get) | **GET** /companies/{company_id}/users/{user_id} | Get single user by ID |
+| [**companies_company_id_users_user_id_patch**](UsersApi.md#companies_company_id_users_user_id_patch) | **PATCH** /companies/{company_id}/users/{user_id} | Update an existing user by ID |
+
+
+## companies_company_id_users_get
+
+> Object companies_company_id_users_get(company_id)
+
+Get a list of all users for a particular company
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::UsersApi.new
+company_id = 'company_id_example' # String | 
+
+begin
+  # Get a list of all users for a particular company
+  result = api_instance.companies_company_id_users_get(company_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->companies_company_id_users_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_get_with_http_info(company_id)
+
+```ruby
+begin
+  # Get a list of all users for a particular company
+  data, status_code, headers = api_instance.companies_company_id_users_get_with_http_info(company_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->companies_company_id_users_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_users_post
+
+> Object companies_company_id_users_post(company_id, user)
+
+Create a new user
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::UsersApi.new
+company_id = 'company_id_example' # String | 
+user = SparteraApiSdk::User.new({company_id: 'company_id_example', status: 'status_example'}) # User | 
+
+begin
+  # Create a new user
+  result = api_instance.companies_company_id_users_post(company_id, user)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->companies_company_id_users_post: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_post_with_http_info(company_id, user)
+
+```ruby
+begin
+  # Create a new user
+  data, status_code, headers = api_instance.companies_company_id_users_post_with_http_info(company_id, user)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->companies_company_id_users_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **user** | [**User**](User.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## companies_company_id_users_user_id_delete
+
+> Object companies_company_id_users_user_id_delete(company_id, user_id)
+
+Delete single user by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::UsersApi.new
+company_id = 'company_id_example' # String | 
+user_id = 'user_id_example' # String | 
+
+begin
+  # Delete single user by ID
+  result = api_instance.companies_company_id_users_user_id_delete(company_id, user_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->companies_company_id_users_user_id_delete: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_user_id_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_delete_with_http_info(company_id, user_id)
+
+```ruby
+begin
+  # Delete single user by ID
+  data, status_code, headers = api_instance.companies_company_id_users_user_id_delete_with_http_info(company_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->companies_company_id_users_user_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_users_user_id_get
+
+> Object companies_company_id_users_user_id_get(company_id, user_id)
+
+Get single user by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::UsersApi.new
+company_id = 'company_id_example' # String | 
+user_id = 'user_id_example' # String | 
+
+begin
+  # Get single user by ID
+  result = api_instance.companies_company_id_users_user_id_get(company_id, user_id)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->companies_company_id_users_user_id_get: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_user_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_get_with_http_info(company_id, user_id)
+
+```ruby
+begin
+  # Get single user by ID
+  data, status_code, headers = api_instance.companies_company_id_users_user_id_get_with_http_info(company_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->companies_company_id_users_user_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## companies_company_id_users_user_id_patch
+
+> Object companies_company_id_users_user_id_patch(company_id, user_id, user)
+
+Update an existing user by ID
+
+### Examples
+
+```ruby
+require 'time'
+require 'spartera_api_sdk'
+# setup authorization
+SparteraApiSdk.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = SparteraApiSdk::UsersApi.new
+company_id = 'company_id_example' # String | 
+user_id = 'user_id_example' # String | 
+user = SparteraApiSdk::User.new({company_id: 'company_id_example', status: 'status_example'}) # User | 
+
+begin
+  # Update an existing user by ID
+  result = api_instance.companies_company_id_users_user_id_patch(company_id, user_id, user)
+  p result
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->companies_company_id_users_user_id_patch: #{e}"
+end
+```
+
+#### Using the companies_company_id_users_user_id_patch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> companies_company_id_users_user_id_patch_with_http_info(company_id, user_id, user)
+
+```ruby
+begin
+  # Update an existing user by ID
+  data, status_code, headers = api_instance.companies_company_id_users_user_id_patch_with_http_info(company_id, user_id, user)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue SparteraApiSdk::ApiError => e
+  puts "Error when calling UsersApi->companies_company_id_users_user_id_patch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+| **user** | [**User**](User.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/example.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+# Simple Spartera API Ruby SDK Example
+# 
+# This example demonstrates basic SDK initialization and configuration.
+
+require 'spartera_api_sdk'
+
+def main
+  puts "🚀 Spartera API Ruby SDK Example"
+  puts "=" * 40
+  
+  # Configure the client
+  SparteraApiSdk.configure do |config|
+    # Set API base URL
+    config.host = ENV['SPARTERA_API_BASE_URL'] || 'https://api.spartera.com'
+    
+    # IMPORTANT: Spartera uses X-API-Key header authentication
+    api_key = ENV['SPARTERA_API_KEY'] || 'your-api-key-here'
+    config.api_key['X-API-Key'] = api_key
+    
+    # Optional: Set timeout
+    config.timeout = 30
+  end
+  
+  # Get company ID from environment
+  company_id = ENV['SPARTERA_COMPANY_ID'] || 'your-company-id'
+  
+  # Check environment variables
+  if ENV['SPARTERA_API_KEY'].nil? || ENV['SPARTERA_API_KEY'] == 'your-api-key-here'
+    puts "⚠️  Set SPARTERA_API_KEY environment variable with your actual API key"
+  end
+  if ENV['SPARTERA_COMPANY_ID'].nil? || ENV['SPARTERA_COMPANY_ID'] == 'your-company-id'
+    puts "⚠️  Set SPARTERA_COMPANY_ID environment variable with your company ID"
+  end
+  
+  puts ""
+  puts "Configured client for: #{SparteraApiSdk.configuration.host}"
+  puts "Company ID: #{company_id}"
+  puts "API configuration created: #{SparteraApiSdk.configuration.host ? 'true' : 'false'}"
+  
+  puts "\n✅ SDK basic initialization test completed successfully!"
+  puts "\n📝 To test with real API calls, set your credentials and modify this example"
+  puts "   export SPARTERA_API_KEY='your-actual-api-key'"
+  puts "   export SPARTERA_COMPANY_ID='your-actual-company-id'"
+end
+
+# Run the example
+if __FILE__ == $0
+  main
+end

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="spartera-com"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="spartera-ruby-sdk"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'