Class: CybridApiOrganization::OrganizationsOrganizationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_organization_ruby/api/organizations_organization_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrganizationsOrganizationApi

Returns a new instance of OrganizationsOrganizationApi.



19
20
21
 
# File 'lib/cybrid_api_organization_ruby/api/organizations_organization_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/cybrid_api_organization_ruby/api/organizations_organization_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_organization(organization_guid, opts = {}) ⇒ OrganizationOrganizationModel

Get organization Retrieve an organization. Required scope: organizations:read

Parameters:

  • organization_guid (String) —

    Identifier for the organization.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cybrid_api_organization_ruby/api/organizations_organization_api.rb', line 27

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

#get_organization_with_http_info(organization_guid, opts = {}) ⇒ Array<(OrganizationOrganizationModel, Integer, Hash)>

Get organization Retrieve an organization. Required scope: organizations:read

Parameters:

  • organization_guid (String) —

    Identifier for the organization.

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

    the optional parameters

Returns:



37
38
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
82
83
 
# File 'lib/cybrid_api_organization_ruby/api/organizations_organization_api.rb', line 37

def get_organization_with_http_info(organization_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsOrganizationApi.get_organization ...'
  end
  # verify the required parameter 'organization_guid' is set
  if @api_client.config.client_side_validation && organization_guid.nil?
    fail ArgumentError, "Missing the required parameter 'organization_guid' when calling OrganizationsOrganizationApi.get_organization"
  end
  # resource path
  local_var_path = '/api/organizations/{organization_guid}'.sub('{' + 'organization_guid' + '}', CGI.escape(organization_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OrganizationOrganizationModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"OrganizationsOrganizationApi.get_organization",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationsOrganizationApi#get_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_organization(organization_guid, patch_organization_organization_model, opts = {}) ⇒ OrganizationOrganizationModel

Patch organization Update an organization. Required scope: organizations:write

Parameters:

  • organization_guid (String) —

    Identifier for the organization.

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

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/cybrid_api_organization_ruby/api/organizations_organization_api.rb', line 91

def update_organization(organization_guid, patch_organization_organization_model, opts = {})
  data, _status_code, _headers = update_organization_with_http_info(organization_guid, patch_organization_organization_model, opts)
  data
end

#update_organization_with_http_info(organization_guid, patch_organization_organization_model, opts = {}) ⇒ Array<(OrganizationOrganizationModel, Integer, Hash)>

Patch organization Update an organization. Required scope: organizations:write

Parameters:

  • organization_guid (String) —

    Identifier for the organization.

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

    the optional parameters

Returns:



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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/cybrid_api_organization_ruby/api/organizations_organization_api.rb', line 102

def update_organization_with_http_info(organization_guid, patch_organization_organization_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationsOrganizationApi.update_organization ...'
  end
  # verify the required parameter 'organization_guid' is set
  if @api_client.config.client_side_validation && organization_guid.nil?
    fail ArgumentError, "Missing the required parameter 'organization_guid' when calling OrganizationsOrganizationApi.update_organization"
  end
  # verify the required parameter 'patch_organization_organization_model' is set
  if @api_client.config.client_side_validation && patch_organization_organization_model.nil?
    fail ArgumentError, "Missing the required parameter 'patch_organization_organization_model' when calling OrganizationsOrganizationApi.update_organization"
  end
  # resource path
  local_var_path = '/api/organizations/{organization_guid}'.sub('{' + 'organization_guid' + '}', CGI.escape(organization_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_organization_organization_model)

  # return_type
  return_type = opts[:debug_return_type] || 'OrganizationOrganizationModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"OrganizationsOrganizationApi.update_organization",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OrganizationsOrganizationApi#update_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end