Class: Bfwd::OrganizationsApi
- Inherits:
-
Object
- Object
- Bfwd::OrganizationsApi
- Defined in:
- lib/bf_ruby2/api/organizations_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_organization(organization, opts = {}) ⇒ OrganizationPagedMetadata
Create an organization.
-
#create_organization_with_http_info(organization, opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Create an organization.
-
#get_all_my_organizations(opts = {}) ⇒ OrganizationPagedMetadata
Returns a collection of all my asociated organizations.
-
#get_all_my_organizations_with_http_info(opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Returns a collection of all my asociated organizations.
-
#get_all_organizations(opts = {}) ⇒ OrganizationPagedMetadata
Returns a collection of all organizations.
-
#get_all_organizations_with_http_info(opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Returns a collection of all organizations.
-
#get_organization_by_customer_code(customer_code, opts = {}) ⇒ OrganizationPagedMetadata
Returns a single organization, specified by the customer-code parameter.
-
#get_organization_by_customer_code_with_http_info(customer_code, opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Returns a single organization, specified by the customer-code parameter.
-
#get_organization_by_id(organization_id, opts = {}) ⇒ OrganizationPagedMetadata
Returns a single Organization, specified by the organization-ID parameter.
-
#get_organization_by_id_with_http_info(organization_id, opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Returns a single Organization, specified by the organization-ID parameter.
-
#get_organization_by_name(name, opts = {}) ⇒ OrganizationPagedMetadata
Returns a single Organization, specified by the name parameter.
-
#get_organization_by_name_with_http_info(name, opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Returns a single Organization, specified by the name parameter.
-
#initialize(api_client = ApiClient.default) ⇒ OrganizationsApi
constructor
A new instance of OrganizationsApi.
-
#update_organization(organization, opts = {}) ⇒ OrganizationPagedMetadata
Update an organization.
-
#update_organization_with_http_info(organization, opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Update an organization.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ OrganizationsApi
Returns a new instance of OrganizationsApi.
19 20 21 |
# File 'lib/bf_ruby2/api/organizations_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/bf_ruby2/api/organizations_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_organization(organization, opts = {}) ⇒ OrganizationPagedMetadata
Create an organization. Bfwd::OrganizationsApi."nickname":"Create","request":"createOrganizationRequest.html","response":"createOrganizationResponse"nickname":"Create","request":"createOrganizationRequest.html","response":"createOrganizationResponse.html"
28 29 30 31 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 28 def create_organization(organization, opts = {}) data, _status_code, _headers = create_organization_with_http_info(organization, opts) return data end |
#create_organization_with_http_info(organization, opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Create an organization. Bfwd::OrganizationsApi."nickname":"Create","request":"createOrganizationRequest.html","response":"createOrganizationResponse"nickname":"Create","request":"createOrganizationRequest.html","response":"createOrganizationResponse.html"
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 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 38 def create_organization_with_http_info(organization, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationsApi.create_organization ..." end # verify the required parameter 'organization' is set if @api_client.config.client_side_validation && organization.nil? fail ArgumentError, "Missing the required parameter 'organization' when calling OrganizationsApi.create_organization" end # resource path local_var_path = "/organizations" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(organization) auth_names = [] 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, :return_type => 'OrganizationPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationsApi#create_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all_my_organizations(opts = {}) ⇒ OrganizationPagedMetadata
Returns a collection of all my asociated organizations. By default 10 values are returned. Records are returned in natural order. Mine","response":"getOrganizationAll.html"
88 89 90 91 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 88 def get_all_my_organizations(opts = {}) data, _status_code, _headers = get_all_my_organizations_with_http_info(opts) return data end |
#get_all_my_organizations_with_http_info(opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Returns a collection of all my asociated organizations. By default 10 values are returned. Records are returned in natural order. Mine","response":"getOrganizationAll.html"
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 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 103 def get_all_my_organizations_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationsApi.get_all_my_organizations ..." end if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order']) fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC' end # resource path local_var_path = "/organizations/mine" # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil? query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil? query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil? query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] 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 => 'OrganizationPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationsApi#get_all_my_organizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all_organizations(opts = {}) ⇒ OrganizationPagedMetadata
Returns a collection of all organizations. By default 10 values are returned. Records are returned in natural order. All","response":"getOrganizationAll.html"
156 157 158 159 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 156 def get_all_organizations(opts = {}) data, _status_code, _headers = get_all_organizations_with_http_info(opts) return data end |
#get_all_organizations_with_http_info(opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Returns a collection of all organizations. By default 10 values are returned. Records are returned in natural order. All","response":"getOrganizationAll.html"
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 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 171 def get_all_organizations_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationsApi.get_all_organizations ..." end if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order']) fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC' end # resource path local_var_path = "/organizations" # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil? query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil? query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil? query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] 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 => 'OrganizationPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationsApi#get_all_organizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_organization_by_customer_code(customer_code, opts = {}) ⇒ OrganizationPagedMetadata
Returns a single organization, specified by the customer-code parameter. by Customer-Code","response":"getOrganizationByCustomer.html"
220 221 222 223 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 220 def get_organization_by_customer_code(customer_code, opts = {}) data, _status_code, _headers = get_organization_by_customer_code_with_http_info(customer_code, opts) return data end |
#get_organization_by_customer_code_with_http_info(customer_code, opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Returns a single organization, specified by the customer-code parameter. by Customer-Code","response":"getOrganizationByCustomer.html"
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 231 def get_organization_by_customer_code_with_http_info(customer_code, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationsApi.get_organization_by_customer_code ..." end # verify the required parameter 'customer_code' is set if @api_client.config.client_side_validation && customer_code.nil? fail ArgumentError, "Missing the required parameter 'customer_code' when calling OrganizationsApi.get_organization_by_customer_code" end # resource path local_var_path = "/organizations/customer-code/{customer-code}".sub('{' + 'customer-code' + '}', customer_code.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] 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 => 'OrganizationPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationsApi#get_organization_by_customer_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_organization_by_id(organization_id, opts = {}) ⇒ OrganizationPagedMetadata
Returns a single Organization, specified by the organization-ID parameter. by id","response":"getOrganizationByID.html"
278 279 280 281 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 278 def get_organization_by_id(organization_id, opts = {}) data, _status_code, _headers = get_organization_by_id_with_http_info(organization_id, opts) return data end |
#get_organization_by_id_with_http_info(organization_id, opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Returns a single Organization, specified by the organization-ID parameter. by id","response":"getOrganizationByID.html"
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 289 def get_organization_by_id_with_http_info(organization_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationsApi.get_organization_by_id ..." end # verify the required parameter 'organization_id' is set if @api_client.config.client_side_validation && organization_id.nil? fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_organization_by_id" end # resource path local_var_path = "/organizations/{organization-ID}".sub('{' + 'organization-ID' + '}', organization_id.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] 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 => 'OrganizationPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationsApi#get_organization_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_organization_by_name(name, opts = {}) ⇒ OrganizationPagedMetadata
Returns a single Organization, specified by the name parameter. by Name","response":"getOrganizationByName.html"
336 337 338 339 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 336 def get_organization_by_name(name, opts = {}) data, _status_code, _headers = get_organization_by_name_with_http_info(name, opts) return data end |
#get_organization_by_name_with_http_info(name, opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Returns a single Organization, specified by the name parameter. by Name","response":"getOrganizationByName.html"
347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 347 def get_organization_by_name_with_http_info(name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationsApi.get_organization_by_name ..." end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling OrganizationsApi.get_organization_by_name" end # resource path local_var_path = "/organizations/name/{name}".sub('{' + 'name' + '}', name.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] 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 => 'OrganizationPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationsApi#get_organization_by_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_organization(organization, opts = {}) ⇒ OrganizationPagedMetadata
Update an organization. Bfwd::OrganizationsApi."nickname":"Updated","request":"updateOrganizationRequest.html","response":"updateOrganizationResponse"nickname":"Updated","request":"updateOrganizationRequest.html","response":"updateOrganizationResponse.html"
393 394 395 396 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 393 def update_organization(organization, opts = {}) data, _status_code, _headers = update_organization_with_http_info(organization, opts) return data end |
#update_organization_with_http_info(organization, opts = {}) ⇒ Array<(OrganizationPagedMetadata, Fixnum, Hash)>
Update an organization. Bfwd::OrganizationsApi."nickname":"Updated","request":"updateOrganizationRequest.html","response":"updateOrganizationResponse"nickname":"Updated","request":"updateOrganizationRequest.html","response":"updateOrganizationResponse.html"
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 |
# File 'lib/bf_ruby2/api/organizations_api.rb', line 403 def update_organization_with_http_info(organization, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: OrganizationsApi.update_organization ..." end # verify the required parameter 'organization' is set if @api_client.config.client_side_validation && organization.nil? fail ArgumentError, "Missing the required parameter 'organization' when calling OrganizationsApi.update_organization" end # resource path local_var_path = "/organizations" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(organization) auth_names = [] 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, :return_type => 'OrganizationPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: OrganizationsApi#update_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |