Class: TeamBattlesSdk::Generated::Webhooks::Item::Deliveries::DeliveriesRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/teambattles_sdk/generated/webhooks/item/deliveries/deliveries_request_builder.rb

Overview

Builds and executes requests for operations under #webhooks#id#deliveries

Defined Under Namespace

Classes: DeliveriesRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new DeliveriesRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



35
36
37
 
# File 'lib/teambattles_sdk/generated/webhooks/item/deliveries/deliveries_request_builder.rb', line 35

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/webhooks/{id}/deliveries{?cursor*,limit*}")
end

Instance Method Details

#by_delivery_id(delivery_id) ⇒ Object

Gets an item from the TeamBattlesSdk::Generated.webhooks.item.deliveries.item collection

Parameters:

  • delivery_id —

    Delivery-log row id to replay.

Returns:

  • a with_delivery_item_request_builder

Raises:

  • (StandardError) 


23
24
25
26
27
28
 
# File 'lib/teambattles_sdk/generated/webhooks/item/deliveries/deliveries_request_builder.rb', line 23

def by_delivery_id(delivery_id)
    raise StandardError, 'delivery_id cannot be null' if delivery_id.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["deliveryId"] = delivery_id
    return TeamBattlesSdk::Generated::Webhooks::Item::Deliveries::Item::WithDeliveryItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#get(request_configuration = nil) ⇒ Object

Returns the endpoint’s delivery log, newest first, with native cursor pagination. Pass limit (1-100) and cursor query params. Requires the webhooks.manage permission and the webhooks feature.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of deliveries_get_response



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/teambattles_sdk/generated/webhooks/item/deliveries/deliveries_request_builder.rb', line 43

def get(request_configuration=nil)
    request_info = self.to_get_request_information(
        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) }
    return @request_adapter.send_async(request_info, lambda {|pn| TeamBattlesSdk::Generated::Webhooks::Item::Deliveries::DeliveriesGetResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#to_get_request_information(request_configuration = nil) ⇒ Object

Returns the endpoint’s delivery log, newest first, with native cursor pagination. Pass limit (1-100) and cursor query params. Requires the webhooks.manage permission and the webhooks feature.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/teambattles_sdk/generated/webhooks/item/deliveries/deliveries_request_builder.rb', line 60

def to_get_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.set_query_string_parameters_from_raw_object(request_configuration.query_parameters)
        request_info.add_request_options(request_configuration.options)
    end
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :GET
    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 deliveries_request_builder

Raises:

  • (StandardError) 


78
79
80
81
 
# File 'lib/teambattles_sdk/generated/webhooks/item/deliveries/deliveries_request_builder.rb', line 78

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