swagger_client

SwaggerClient - the Ruby gem for the Crelate API Reference

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build swagger_client.gemspec

Then either install the gem locally:

gem install ./swagger_client-1.0.0.gem

(for development, run gem install --dev ./swagger_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'swagger_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'swagger_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'swagger_client'

api_instance = SwaggerClient::CompaniesApi.new

company_id = "company_id_example" # String | identifier

api_key = "api_key_example" # String | crelate api key


begin
  #delete a company
  result = api_instance.public_api_delete_account(company_id, api_key)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling CompaniesApi->public_api_delete_account: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://app.crelate.com

Class	Method	HTTP request	Description
SwaggerClient::CompaniesApi	public_api_delete_account	DELETE /api/pub/v1/companies/companyId	delete a company
SwaggerClient::CompaniesApi	public_api_delete_account_note	DELETE /api/pub/v1/companies/companyId/notes/noteId	delete a note for a company
SwaggerClient::CompaniesApi	public_api_delete_account_task	DELETE /api/pub/v1/companies/companyId/tasks/taskId	delete a task for a company
SwaggerClient::CompaniesApi	public_api_get_account	GET /api/pub/v1/companies/companyId	retrieve a company
SwaggerClient::CompaniesApi	public_api_get_account_note	GET /api/pub/v1/companies/companyId/notes/noteId	retrieve a note for a company
SwaggerClient::CompaniesApi	public_api_get_account_task	GET /api/pub/v1/companies/companyId/tasks/taskId	get a task for a company
SwaggerClient::CompaniesApi	public_api_post_account	POST /api/pub/v1/companies	create a company
SwaggerClient::CompaniesApi	public_api_post_account_note	POST /api/pub/v1/companies/companyId/notes	create a note for a company
SwaggerClient::CompaniesApi	public_api_post_account_task	POST /api/pub/v1/companies/companyId/tasks	create a task for a company
SwaggerClient::CompaniesApi	public_api_put_account	PUT /api/pub/v1/companies/companyId	update a company
SwaggerClient::CompaniesApi	public_api_put_account_note	PUT /api/pub/v1/companies/companyId/notes/noteId	update a note for a company
SwaggerClient::CompaniesApi	public_api_put_account_task	PUT /api/pub/v1/companies/companyId/tasks/taskId	update a task for a company
SwaggerClient::ContactsApi	public_api_delete_contact	DELETE /api/pub/v1/contacts/contactId	delete a contact
SwaggerClient::ContactsApi	public_api_delete_contact_note	DELETE /api/pub/v1/contacts/contactId/notes/noteId	delete a note for a contact
SwaggerClient::ContactsApi	public_api_delete_contact_task	DELETE /api/pub/v1/contacts/contactId/tasks/taskId	delete a task for a contact
SwaggerClient::ContactsApi	public_api_get_contact	GET /api/pub/v1/contacts/contactId	retrieve a contact
SwaggerClient::ContactsApi	public_api_get_contact_note	GET /api/pub/v1/contacts/contactId/notes/noteId	get a note for a contact
SwaggerClient::ContactsApi	public_api_get_contact_task	GET /api/pub/v1/contacts/contactId/tasks/taskId	get a task for a contact
SwaggerClient::ContactsApi	public_api_post_contact	POST /api/pub/v1/contacts	create a contact
SwaggerClient::ContactsApi	public_api_post_contact_note	POST /api/pub/v1/contacts/contactId/notes	create a note for a contact
SwaggerClient::ContactsApi	public_api_post_contact_task	POST /api/pub/v1/contacts/contactId/tasks	save a task for a contact
SwaggerClient::ContactsApi	public_api_put_contact	PUT /api/pub/v1/contacts/contactId	update a contact
SwaggerClient::ContactsApi	public_api_put_contact_note	PUT /api/pub/v1/contacts/contactId/notes/noteId	update a note for a contact
SwaggerClient::ContactsApi	public_api_put_contact_task	PUT /api/pub/v1/contacts/contactId/tasks/taskId	update a task for a contact
SwaggerClient::JobsApi	public_api_delete_job	DELETE /api/pub/v1/jobs/jobId	delete a job
SwaggerClient::JobsApi	public_api_delete_job_note	DELETE /api/pub/v1/jobs/jobId/notes/noteId	delete a note for a contact
SwaggerClient::JobsApi	public_api_delete_job_task	DELETE /api/pub/v1/jobs/jobId/tasks/taskId	delete a task for a contact
SwaggerClient::JobsApi	public_api_get_job	GET /api/pub/v1/jobs/jobId	retrieve a job
SwaggerClient::JobsApi	public_api_get_job_note	GET /api/pub/v1/jobs/jobId/notes/noteId	get a note for a contact
SwaggerClient::JobsApi	public_api_get_job_task	GET /api/pub/v1/jobs/jobId/tasks/taskId	get a task for a contact
SwaggerClient::JobsApi	public_api_post_job	POST /api/pub/v1/jobs	create a job
SwaggerClient::JobsApi	public_api_post_job_note	POST /api/pub/v1/jobs/jobId/notes	create a note for a contact
SwaggerClient::JobsApi	public_api_post_job_task	POST /api/pub/v1/jobs/jobId/tasks	create a task for a contact
SwaggerClient::JobsApi	public_api_put_job	PUT /api/pub/v1/jobs/jobId	update a job
SwaggerClient::JobsApi	public_api_put_job_note	PUT /api/pub/v1/jobs/jobId/notes/noteId	update a note for a contact
SwaggerClient::JobsApi	public_api_put_job_task	PUT /api/pub/v1/jobs/jobId/tasks/taskId	update a task for a contact
SwaggerClient::NotesApi	public_api_delete_note	DELETE /api/pub/v1/notes/noteId	delete a note
SwaggerClient::NotesApi	public_api_get_note	GET /api/pub/v1/notes/noteId	retrieve a note
SwaggerClient::NotesApi	public_api_post_note	POST /api/pub/v1/notes	create a note
SwaggerClient::NotesApi	public_api_put_note	PUT /api/pub/v1/notes/noteId	update a note
SwaggerClient::TasksApi	public_api_delete_task	DELETE /api/pub/v1/tasks/taskId	delete a task
SwaggerClient::TasksApi	public_api_get_task	GET /api/pub/v1/tasks/taskId	retrieve a task
SwaggerClient::TasksApi	public_api_post_task	POST /api/pub/v1/tasks	create a task
SwaggerClient::TasksApi	public_api_put_task	PUT /api/pub/v1/tasks/taskId	update a task

Documentation for Models

• SwaggerClient::CodePageDataItem
• SwaggerClient::DecoderFallback
• SwaggerClient::EmailAttachment
• SwaggerClient::EncoderFallback
• SwaggerClient::Encoding
• SwaggerClient::ExtendedContentResult
• SwaggerClient::PublicApiGetAccountResponse
• SwaggerClient::PublicApiGetContactResponse
• SwaggerClient::PublicApiGetJobResponse
• SwaggerClient::PublicApiGetNoteResponse
• SwaggerClient::PublicApiGetTaskResponse
• SwaggerClient::PublicApiIdResponse
• SwaggerClient::PublicApiRecordOwner
• SwaggerClient::PublicApiSaveAccountRequest
• SwaggerClient::PublicApiSaveContactRequest
• SwaggerClient::PublicApiSaveJobRequest
• SwaggerClient::PublicApiSaveJobRequestJobType
• SwaggerClient::PublicApiSaveNoteRequest
• SwaggerClient::PublicApiSaveTaskRequest
• SwaggerClient::SendSubmittalDetail

Documentation for Authorization

All endpoints do not require authorization.