Module: Reach

Extended by:
SingleForwardable
Defined in:
lib/reach-ruby/rest/api.rb,
lib/reach-ruby.rb,
lib/reach-ruby/version.rb,
lib/reach-ruby/rest/client.rb,
lib/reach-ruby/framework/values.rb,
lib/reach-ruby/http/http_client.rb,
lib/reach-ruby/framework/request.rb,
lib/reach-ruby/framework/response.rb,
lib/reach-ruby/rest/api/authentix.rb,
lib/reach-ruby/rest/api/messaging.rb,
lib/reach-ruby/util/configuration.rb,
lib/reach-ruby/framework/rest/page.rb,
lib/reach-ruby/framework/serialize.rb,
lib/reach-ruby/framework/rest/error.rb,
lib/reach-ruby/framework/rest/domain.rb,
lib/reach-ruby/framework/rest/helper.rb,
lib/reach-ruby/framework/rest/version.rb,
lib/reach-ruby/framework/rest/resource.rb,
lib/reach-ruby/framework/reach_response.rb,
lib/reach-ruby/security/request_validator.rb,
lib/reach-ruby/rest/api/messaging/messaging_item.rb,
lib/reach-ruby/rest/api/authentix/configuration_item.rb,
lib/reach-ruby/rest/api/authentix/authentication_trial_item.rb,
lib/reach-ruby/rest/api/authentix/authentication_trial_stat_item.rb,
lib/reach-ruby/rest/api/authentix/configuration_item/authentication_item.rb,
lib/reach-ruby/rest/api/authentix/configuration_item/authentication_control_item.rb

Overview

This code was generated by

___ ___   _   ___ _  _    _____ _   _    _  ___   ___      _   ___ ___      ___   _   ___     ___ ___ _  _ ___ ___    _ _____ ___  ___

| _ \ __| /_\ / __| || |_| /\ | | | |/ | \ / / | /_\ | _ ) __|_ / _ \ /_\ |_ _|__ / __| __| | | __| _ \ /__ _/ _ | _ \ | / _| / _ \ (__| __ |_|| |/ _ | |__| ‘ < \ V /| |__ / _ | _ __ ___| (_) / _ \ | |_| (_ | _|| .` | _|| / / _ | || (_) | / |_|__/_/ ___|||_| |// __||_\ |_| |_// _// __// __| ___|__||_|__||// __| __/||_\

Reach Messaging API
Reach SMS API helps you add robust messaging capabilities to your applications.  Using this REST API, you can * send SMS messages * track the delivery of sent messages * schedule SMS messages to send at a later time * retrieve and modify message history

NOTE: This class is auto generated by OpenAPI Generator.
https://openapi-generator.tech
Do not edit the class manually.

Defined Under Namespace

Modules: HTTP, REST, Security, Util Classes: ReachResponse, Request, Response, Values

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure {|configuration| ... } ⇒ Object

Pre-configure with ApiUser and ApiKey so that you don’t need to pass them to various initializers each time.

Yields:

  • (configuration) 


33
34
35
 
# File 'lib/reach-ruby.rb', line 33

def self.configure(&block)
  yield configuration
end

.deserialize_iso8601_date(date) ⇒ Object 



32
33
34
 
# File 'lib/reach-ruby/framework/serialize.rb', line 32

def self.deserialize_iso8601_date(date)
  Date.parse(date) unless date.nil?
end

.deserialize_iso8601_datetime(date) ⇒ Object 



36
37
38
 
# File 'lib/reach-ruby/framework/serialize.rb', line 36

def self.deserialize_iso8601_datetime(date)
  Time.parse(date) unless date.nil?
end

.deserialize_rfc2822(date) ⇒ Object 



28
29
30
 
# File 'lib/reach-ruby/framework/serialize.rb', line 28

def self.deserialize_rfc2822(date)
  Time.rfc2822(date) unless date.nil?
end

.flatten(map, result = {}, previous = []) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/reach-ruby/framework/serialize.rb', line 48

def self.flatten(map, result = {}, previous = [])
  map.each do |key, value|
    if value.is_a? Hash
      self.flatten(value, result, previous + [key])
    else
      result[(previous + [key]).join('.')] = value
    end
  end

  result
end

.prefixed_collapsible_map(map, prefix) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/reach-ruby/framework/serialize.rb', line 60

def self.prefixed_collapsible_map(map, prefix)
  result = {}
  if map.is_a? Hash
    flattened = self.flatten(map)
    result = {}
    flattened.each do |key, value|
      result[prefix + '.' + key] = value
    end
  end

  result
end

.serialize_iso8601_date(date) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
 
# File 'lib/reach-ruby/framework/serialize.rb', line 4

def self.serialize_iso8601_date(date)
  if date.eql?(:unset)
    date
  elsif date.is_a?(Date)
    date.iso8601
  elsif date.is_a?(Time)
    date.strftime('%Y-%m-%d')
  elsif date.is_a?(String)
    date
  end
end

.serialize_iso8601_datetime(date) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/reach-ruby/framework/serialize.rb', line 16

def self.serialize_iso8601_datetime(date)
  if date.eql?(:unset)
    date
  elsif date.is_a?(Date)
    Time.new(date.year, date.month, date.day).utc.iso8601
  elsif date.is_a?(Time)
    date.utc.iso8601
  elsif date.is_a?(String)
    date
  end
end

.serialize_list(input_list) ⇒ Object 



73
74
75
76
77
78
79
80
 
# File 'lib/reach-ruby/framework/serialize.rb', line 73

def self.serialize_list(input_list)
  return input_list unless input_list.is_a? Array
  result = []
  input_list.each do |e|
    result.push yield e
  end
  result
end

.serialize_object(object) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/reach-ruby/framework/serialize.rb', line 40

def self.serialize_object(object)
  if object.is_a?(Hash) || object.is_a?(Array)
    JSON.generate(object)
  else
    object
  end
end