Class: OrderCloud::PasswordResetApi

Inherits:
Object
  • Object
show all
Defined in:
lib/order_cloud/api/password_reset_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PasswordResetApi

Returns a new instance of PasswordResetApi.



30
31
32
 
# File 'lib/order_cloud/api/password_reset_api.rb', line 30

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/order_cloud/api/password_reset_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#reset_password_by_verification_code(verification_code, password_reset, opts = {}) ⇒ nil

Parameters:

  • verification_code —

    Verification code of the forgotten password.

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

    the optional parameters

Returns:

  • (nil) 


40
41
42
43
 
# File 'lib/order_cloud/api/password_reset_api.rb', line 40

def reset_password_by_verification_code(verification_code, password_reset, opts = {})
  reset_password_by_verification_code_with_http_info(verification_code, password_reset, opts)
  return nil
end

#reset_password_by_verification_code_with_http_info(verification_code, password_reset, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • verification_code —

    Verification code of the forgotten password.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/order_cloud/api/password_reset_api.rb', line 51

def reset_password_by_verification_code_with_http_info(verification_code, password_reset, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PasswordResetApi.reset_password_by_verification_code ..."
  end
  # verify the required parameter 'verification_code' is set
  fail ArgumentError, "Missing the required parameter 'verification_code' when calling PasswordResetApi.reset_password_by_verification_code" if verification_code.nil?
  # verify the required parameter 'password_reset' is set
  fail ArgumentError, "Missing the required parameter 'password_reset' when calling PasswordResetApi.reset_password_by_verification_code" if password_reset.nil?
  # resource path
  local_var_path = "/password/reset/{verificationCode}".sub('{format}','json').sub('{' + 'verificationCode' + '}', verification_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(password_reset)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PasswordResetApi#reset_password_by_verification_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#send_verification_code(password_reset_request, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


99
100
101
102
 
# File 'lib/order_cloud/api/password_reset_api.rb', line 99

def send_verification_code(password_reset_request, opts = {})
  send_verification_code_with_http_info(password_reset_request, opts)
  return nil
end

#send_verification_code_with_http_info(password_reset_request, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
142
143
144
145
146
147
148
 
# File 'lib/order_cloud/api/password_reset_api.rb', line 109

def send_verification_code_with_http_info(password_reset_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PasswordResetApi.send_verification_code ..."
  end
  # verify the required parameter 'password_reset_request' is set
  fail ArgumentError, "Missing the required parameter 'password_reset_request' when calling PasswordResetApi.send_verification_code" if password_reset_request.nil?
  # resource path
  local_var_path = "/password/reset".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'text/plain; charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(password_reset_request)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PasswordResetApi#send_verification_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end