MessenteApi::ContactsApi

All URIs are relative to https://api.messente.com/v1

Method	HTTP request	Description
add_contact_to_group	POST /phonebook/groups/{groupId}/contacts/{phone}	Adds a contact to a group
create_contact	POST /phonebook/contacts	Creates a new contact
delete_contact	DELETE /phonebook/contacts/{phone}	Deletes a contact
fetch_contact	GET /phonebook/contacts/{phone}	Lists a contact
fetch_contact_groups	GET /phonebook/contacts/{phone}/groups	Lists groups of a contact
fetch_contacts	GET /phonebook/contacts	Returns all contacts
remove_contact_from_group	DELETE /phonebook/groups/{groupId}/contacts/{phone}	Removes a contact from a group
update_contact	PATCH /phonebook/contacts/{phone}	Updates a contact

add_contact_to_group

Object add_contact_to_group(group_id, phone)

Adds a contact to a group

Examples

require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MessenteApi::ContactsApi.new
group_id = '5792a02a-e5c2-422b-a0a0-0ae65d814663' # String | String in UUID format
phone = '+37251000000' # String | A phone number

begin
  # Adds a contact to a group
  result = api_instance.add_contact_to_group(group_id, phone)
  p result
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->add_contact_to_group: #{e}"
end

Using the add_contact_to_group_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Object, Integer, Hash)> add_contact_to_group_with_http_info(group_id, phone)

begin
  # Adds a contact to a group
  data, status_code, headers = api_instance.add_contact_to_group_with_http_info(group_id, phone)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Object
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->add_contact_to_group_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
group_id	String	String in UUID format
phone	String	A phone number

Return type

Object

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

create_contact

create_contact(contact_fields)

Creates a new contact

Examples

require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MessenteApi::ContactsApi.new
contact_fields = MessenteApi::ContactFields.new({phone_number: 'phone_number_example'}) # ContactFields | 

begin
  # Creates a new contact
  result = api_instance.create_contact(contact_fields)
  p result
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->create_contact: #{e}"
end

Using the create_contact_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_contact_with_http_info(contact_fields)

begin
  # Creates a new contact
  data, status_code, headers = api_instance.create_contact_with_http_info(contact_fields)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ContactEnvelope>
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->create_contact_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
contact_fields	ContactFields

Return type

ContactEnvelope

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

delete_contact

delete_contact(phone)

Deletes a contact

Examples

require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MessenteApi::ContactsApi.new
phone = '+37251000000' # String | A phone number

begin
  # Deletes a contact
  api_instance.delete_contact(phone)
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->delete_contact: #{e}"
end

Using the delete_contact_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_contact_with_http_info(phone)

begin
  # Deletes a contact
  data, status_code, headers = api_instance.delete_contact_with_http_info(phone)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->delete_contact_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
phone	String	A phone number

Return type

nil (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

fetch_contact

fetch_contact(phone)

Lists a contact

Examples

require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MessenteApi::ContactsApi.new
phone = '+37251000000' # String | A phone number

begin
  # Lists a contact
  result = api_instance.fetch_contact(phone)
  p result
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->fetch_contact: #{e}"
end

Using the fetch_contact_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> fetch_contact_with_http_info(phone)

begin
  # Lists a contact
  data, status_code, headers = api_instance.fetch_contact_with_http_info(phone)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ContactEnvelope>
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->fetch_contact_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
phone	String	A phone number

Return type

ContactEnvelope

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

fetch_contact_groups

fetch_contact_groups(phone)

Lists groups of a contact

Examples

require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MessenteApi::ContactsApi.new
phone = '+37251000000' # String | A phone number

begin
  # Lists groups of a contact
  result = api_instance.fetch_contact_groups(phone)
  p result
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->fetch_contact_groups: #{e}"
end

Using the fetch_contact_groups_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> fetch_contact_groups_with_http_info(phone)

begin
  # Lists groups of a contact
  data, status_code, headers = api_instance.fetch_contact_groups_with_http_info(phone)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GroupListEnvelope>
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->fetch_contact_groups_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
phone	String	A phone number

Return type

GroupListEnvelope

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

fetch_contacts

fetch_contacts(opts)

Returns all contacts

Examples

require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MessenteApi::ContactsApi.new
opts = {
  group_ids: ['inner_example'] # Array<String> | Optional one or many group id strings in UUID format. For example: \"/contacts?groupIds=group_id_one&groupIds=group_id_two\" 
}

begin
  # Returns all contacts
  result = api_instance.fetch_contacts(opts)
  p result
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->fetch_contacts: #{e}"
end

Using the fetch_contacts_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> fetch_contacts_with_http_info(opts)

begin
  # Returns all contacts
  data, status_code, headers = api_instance.fetch_contacts_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ContactListEnvelope>
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->fetch_contacts_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
group_ids	Array<String>	Optional one or many group id strings in UUID format. For example: "/contacts?groupIds=group_id_one&groupIds=group_id_two"	[optional]

Return type

ContactListEnvelope

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

remove_contact_from_group

remove_contact_from_group(group_id, phone)

Removes a contact from a group

Examples

require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MessenteApi::ContactsApi.new
group_id = '5792a02a-e5c2-422b-a0a0-0ae65d814663' # String | String in UUID format
phone = '+37251000000' # String | A phone number

begin
  # Removes a contact from a group
  api_instance.remove_contact_from_group(group_id, phone)
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->remove_contact_from_group: #{e}"
end

Using the remove_contact_from_group_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> remove_contact_from_group_with_http_info(group_id, phone)

begin
  # Removes a contact from a group
  data, status_code, headers = api_instance.remove_contact_from_group_with_http_info(group_id, phone)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->remove_contact_from_group_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
group_id	String	String in UUID format
phone	String	A phone number

Return type

nil (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

update_contact

update_contact(phone, contact_update_fields)

Updates a contact

Examples

require 'time'
require 'messente_api'
# setup authorization
MessenteApi.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MessenteApi::ContactsApi.new
phone = '+37251000000' # String | A phone number
contact_update_fields = MessenteApi::ContactUpdateFields.new # ContactUpdateFields | 

begin
  # Updates a contact
  result = api_instance.update_contact(phone, contact_update_fields)
  p result
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->update_contact: #{e}"
end

Using the update_contact_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_contact_with_http_info(phone, contact_update_fields)

begin
  # Updates a contact
  data, status_code, headers = api_instance.update_contact_with_http_info(phone, contact_update_fields)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ContactEnvelope>
rescue MessenteApi::ApiError => e
  puts "Error when calling ContactsApi->update_contact_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
phone	String	A phone number
contact_update_fields	ContactUpdateFields

Return type

ContactEnvelope

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

ContactsApi.md

Latest commit

History

ContactsApi.md

File metadata and controls

MessenteApi::ContactsApi

add_contact_to_group

Examples

Using the add_contact_to_group_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

create_contact

Examples

Using the create_contact_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_contact

Examples

Using the delete_contact_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

fetch_contact

Examples

Using the fetch_contact_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

fetch_contact_groups

Examples

Using the fetch_contact_groups_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

fetch_contacts

Examples

Using the fetch_contacts_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

remove_contact_from_group

Examples

Using the remove_contact_from_group_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

update_contact

Examples

Using the update_contact_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers