Class: PhoneComClient::OauthClientsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OauthClientsApi

Returns a new instance of OauthClientsApi.



19
20
21
 
# File 'lib/phone_com_client/api/oauth_clients_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/oauth_clients_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_account_oauth_client(account_id, client_id, opts = {}) ⇒ DeleteEntry

Delete an individual OAuth client. Delete an individual OAuth client. See Account OAuth Clients for more info on the properties.

Parameters:

  • account_id —

    Account ID

  • client_id —

    Client ID

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

    the optional parameters

Returns:



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

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

#delete_account_oauth_client_with_http_info(account_id, client_id, opts = {}) ⇒ Array<(DeleteEntry, Fixnum, Hash)>

Delete an individual OAuth client. Delete an individual OAuth client. See Account OAuth Clients for more info on the properties.

Parameters:

  • account_id —

    Account ID

  • client_id —

    Client ID

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

    the optional parameters

Returns:

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

    DeleteEntry 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/oauth_clients_api.rb', line 39

def (, client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OauthClientsApi.delete_account_oauth_client ...'
  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 OauthClientsApi.delete_account_oauth_client"
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling OauthClientsApi.delete_account_oauth_client"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/oauth/clients/{client_id}'.sub('{' + 'account_id' + '}', .to_s).sub('{' + 'client_id' + '}', client_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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DeleteEntry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OauthClientsApi#delete_account_oauth_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_oauth_client(account_id, client_id, opts = {}) ⇒ OauthClientFull

Show details of an individual OAuth client. Show details of an individual OAuth client. See Account OAuth Clients for more info on the properties.

Parameters:

  • account_id —

    Account ID

  • client_id —

    Client ID

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

    the optional parameters

Returns:



88
89
90
91
 
# File 'lib/phone_com_client/api/oauth_clients_api.rb', line 88

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

#get_account_oauth_client_with_http_info(account_id, client_id, opts = {}) ⇒ Array<(OauthClientFull, Fixnum, Hash)>

Show details of an individual OAuth client. Show details of an individual OAuth client. See Account OAuth Clients for more info on the properties.

Parameters:

  • account_id —

    Account ID

  • client_id —

    Client ID

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

    the optional parameters

Returns:

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

    OauthClientFull data, response status code and response headers



99
100
101
102
103
104
105
106
107
108
109
110
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
 
# File 'lib/phone_com_client/api/oauth_clients_api.rb', line 99

def (, client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OauthClientsApi.get_account_oauth_client ...'
  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 OauthClientsApi.get_account_oauth_client"
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling OauthClientsApi.get_account_oauth_client"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/oauth/clients/{client_id}'.sub('{' + 'account_id' + '}', .to_s).sub('{' + 'client_id' + '}', client_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 => 'OauthClientFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OauthClientsApi#get_account_oauth_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_account_oauth_clients(account_id, opts = {}) ⇒ ListOauthClients

Get a list of OAuth clients for an account. Get a list of OAuth clients for an account. See Account OAuth Clients for more info on the properties.

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

  • :sort_id (String) —

    ID sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:



152
153
154
155
 
# File 'lib/phone_com_client/api/oauth_clients_api.rb', line 152

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

#list_account_oauth_clients_with_http_info(account_id, opts = {}) ⇒ Array<(ListOauthClients, Fixnum, Hash)>

Get a list of OAuth clients for an account. Get a list of OAuth clients for an account. See Account OAuth Clients for more info on the properties.

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

  • :sort_id (String) —

    ID sorting

  • :limit (Integer) —

    Max results

  • :offset (Integer) —

    Results to skip

  • :fields (String) —

    Field set

Returns:

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

    ListOauthClients data, response status code and response headers



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/phone_com_client/api/oauth_clients_api.rb', line 167

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OauthClientsApi.list_account_oauth_clients ...'
  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 OauthClientsApi.list_account_oauth_clients"
  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 OauthClientsApi.list_account_oauth_clients, must conform to the pattern /asc|desc/."
  end

  # resource path
  local_var_path = '/accounts/{account_id}/oauth/clients'.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[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].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 => 'ListOauthClients')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OauthClientsApi#list_account_oauth_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end