Class: PhoneComClient::ExpressServiceCodesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ExpressServiceCodesApi

Returns a new instance of ExpressServiceCodesApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_account_express_srv_code(account_id, code_id, opts = {}) ⇒ ExpressServiceCodeFull

Show details of an account Express Service Code This service shows the details of an Account Express Service Code.

Parameters:

  • account_id —

    Account ID

  • code_id —

    Device ID

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

    the optional parameters

Returns:



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

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

#get_account_express_srv_code_with_http_info(account_id, code_id, opts = {}) ⇒ Array<(ExpressServiceCodeFull, Fixnum, Hash)>

Show details of an account Express Service Code This service shows the details of an Account Express Service Code.

Parameters:

  • account_id —

    Account ID

  • code_id —

    Device ID

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

    the optional parameters

Returns:

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

    ExpressServiceCodeFull 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/express_service_codes_api.rb', line 39

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

#list_account_express_srv_codes(account_id, opts = {}) ⇒ ListExpressServiceCodes

Get the Express Service Code associated with your account in list format. Get the Express Service Code associated with your account in list format. See Express Service Codes for more detail.

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

Returns:



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

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

#list_account_express_srv_codes_with_http_info(account_id, opts = {}) ⇒ Array<(ListExpressServiceCodes, Fixnum, Hash)>

Get the Express Service Code associated with your account in list format. Get the Express Service Code associated with your account in list format. See Express Service Codes for more detail.

Parameters:

  • account_id —

    Account ID

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

    the optional parameters

Options Hash (opts):

  • :filters_id (Array<String>) —

    ID filter

Returns:

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

    ListExpressServiceCodes 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
 
# File 'lib/phone_com_client/api/express_service_codes_api.rb', line 99

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ExpressServiceCodesApi.list_account_express_srv_codes ...'
  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 ExpressServiceCodesApi.list_account_express_srv_codes"
  end
  # resource path
  local_var_path = '/accounts/{account_id}/express-service-codes'.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?

  # 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 => 'ListExpressServiceCodes')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ExpressServiceCodesApi#list_account_express_srv_codes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end