Class: TeamBattlesSdk::Generated::Orgs::OrgsRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/teambattles_sdk/generated/orgs/orgs_request_builder.rb

Overview

Builds and executes requests for operations under #orgs

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new OrgsRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



39
40
41
 
# File 'lib/teambattles_sdk/generated/orgs/orgs_request_builder.rb', line 39

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/orgs")
end

Instance Method Details

#by_identifier(identifier) ⇒ Object

Gets an item from the TeamBattlesSdk::Generated.orgs.item collection

Parameters:

  • identifier —

    Organization slug or Convex organization ID.

Returns:

  • a with_identifier_item_request_builder

Raises:

  • (StandardError) 


27
28
29
30
31
32
 
# File 'lib/teambattles_sdk/generated/orgs/orgs_request_builder.rb', line 27

def by_identifier(identifier)
    raise StandardError, 'identifier cannot be null' if identifier.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["identifier"] = identifier
    return TeamBattlesSdk::Generated::Orgs::Item::WithIdentifierItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#discover ⇒ Object

The discover property



19
20
21
 
# File 'lib/teambattles_sdk/generated/orgs/orgs_request_builder.rb', line 19

def discover()
    return TeamBattlesSdk::Generated::Orgs::Discover::DiscoverRequestBuilder.new(@path_parameters, @request_adapter)
end

#post(body, request_configuration = nil) ⇒ Object

Creates a new organization as the personal API key owner. The owner becomes the organization owner. Role ceilings and cascades are enforced exactly as in the web app. Requires orgs.profile:read-write and API writes access. Supports an optional ‘Idempotency-Key` header for safe retries.

Parameters:

  • body —

    Creates a new organization as the API key owner.

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of create_org_response

Raises:

  • (StandardError) 


48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/teambattles_sdk/generated/orgs/orgs_request_builder.rb', line 48

def post(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = self.to_post_request_information(
        body, request_configuration
    )
    error_mapping = Hash.new
    error_mapping["400"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["401"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["403"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["404"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["429"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["500"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| TeamBattlesSdk::Generated::Models::CreateOrgResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#to_post_request_information(body, request_configuration = nil) ⇒ Object

Creates a new organization as the personal API key owner. The owner becomes the organization owner. Role ceilings and cascades are enforced exactly as in the web app. Requires orgs.profile:read-write and API writes access. Supports an optional ‘Idempotency-Key` header for safe retries.

Parameters:

  • body —

    Creates a new organization as the API key owner.

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information

Raises:

  • (StandardError) 


68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/teambattles_sdk/generated/orgs/orgs_request_builder.rb', line 68

def to_post_request_information(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.add_request_options(request_configuration.options)
    end
    request_info.set_content_from_parsable(@request_adapter, 'application/json', body)
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :POST
    request_info.headers.try_add('Accept', 'application/json')
    return request_info
end

#with_url(raw_url) ⇒ Object

Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.

Parameters:

  • raw_url —

    The raw URL to use for the request builder.

Returns:

  • a orgs_request_builder

Raises:

  • (StandardError) 


87
88
89
90
 
# File 'lib/teambattles_sdk/generated/orgs/orgs_request_builder.rb', line 87

def with_url(raw_url)
    raise StandardError, 'raw_url cannot be null' if raw_url.nil?
    return OrgsRequestBuilder.new(raw_url, @request_adapter)
end