Class: PhoneComClient::ApplicationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/phone_com_client/api/applications_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApplicationsApi

Returns a new instance of ApplicationsApi.



19
20
21
 
# File 'lib/phone_com_client/api/applications_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/phone_com_client/api/applications_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_account_application(account_id, application_id, opts = {}) ⇒ ApplicationFull

Show details of an individual Application on a given account. Show details of an individual Application on a given account.

Parameters:

  • account_id —

    Account ID

  • application_id —

    Application ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/phone_com_client/api/applications_api.rb', line 28

def (, application_id, opts = {})
  data, _status_code, _headers = (, application_id, opts)
  data
end

#get_account_application_with_http_info(account_id, application_id, opts = {}) ⇒ Array<(ApplicationFull, Fixnum, Hash)>

Show details of an individual Application on a given account. Show details of an individual Application on a given account.

Parameters:

  • account_id —

    Account ID

  • application_id —

    Application ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApplicationFull, Fixnum, Hash)>) —

    ApplicationFull data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/phone_com_client/api/applications_api.rb', line 39

def (, application_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationsApi.get_account_application ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ApplicationsApi.get_account_application"
  end
  # verify the required parameter 'application_id' is set
  if @api_client.config.client_side_validation && application_id.nil?
    fail ArgumentError, "Missing the required parameter 'application_id' when calling ApplicationsApi.get_account_application"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/applications/{application_id}'.sub('{' + 'account_id' + '}', .to_s).sub('{' + 'application_id' + '}', application_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApplicationFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationsApi#get_account_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_account_applications(account_id, opts = {}) ⇒ ListApplications

This service lists the Applications on a given account Show details of an individual Application on a given account.

Parameters:

  • account_id —

    Account ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

  • :filters_name (Array<String>) —

    Name filter

  • :sort_id (String) —

    ID sorting

  • :sort_name (String) —

    Name sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:



94
95
96
97
 
# File 'lib/phone_com_client/api/applications_api.rb', line 94

def (, opts = {})
  data, _status_code, _headers = (, opts)
  data
end

#list_account_applications_with_http_info(account_id, opts = {}) ⇒ Array<(ListApplications, Fixnum, Hash)>

This service lists the Applications on a given account Show details of an individual Application on a given account.

Parameters:

  • account_id —

    Account ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

  • :filters_name (Array<String>) —

    Name filter

  • :sort_id (String) —

    ID sorting

  • :sort_name (String) —

    Name sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:

  • (Array<(ListApplications, Fixnum, Hash)>) —

    ListApplications data, response status code and response headers



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/phone_com_client/api/applications_api.rb', line 111

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApplicationsApi.list_account_applications ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling ApplicationsApi.list_account_applications"
  end
  if @api_client.config.client_side_validation && !opts[:'sort_id'].nil? && opts[:'sort_id'] !~ Regexp.new(/asc|desc/)
    fail ArgumentError, "invalid value for 'opts[:\"sort_id\"]' when calling ApplicationsApi.list_account_applications, must conform to the pattern /asc|desc/."
  end

  if @api_client.config.client_side_validation && !opts[:'sort_name'].nil? && opts[:'sort_name'] !~ Regexp.new(/asc|desc/)
    fail ArgumentError, "invalid value for 'opts[:\"sort_name\"]' when calling ApplicationsApi.list_account_applications, must conform to the pattern /asc|desc/."
  end

  # resource path
  local_var_path = '/accounts/{account_id}/applications'.sub('{' + 'account_id' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'filters[id]'] = @api_client.build_collection_param(opts[:'filters_id'], :multi) if !opts[:'filters_id'].nil?
  query_params[:'filters[name]'] = @api_client.build_collection_param(opts[:'filters_name'], :multi) if !opts[:'filters_name'].nil?
  query_params[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].nil?
  query_params[:'sort[name]'] = opts[:'sort_name'] if !opts[:'sort_name'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListApplications')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ApplicationsApi#list_account_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end