Class: MicrosoftGraph::Agreements::Item::File::FileRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/agreements/item/file/file_request_builder.rb

Overview

Provides operations to manage the file property of the microsoft.graph.agreement entity.

Defined Under Namespace

Classes: FileRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new FileRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



30
31
32
 
# File 'lib/agreements/item/file/file_request_builder.rb', line 30

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/agreements/{agreement%2Did}/file{?%24select,%24expand}")
end

Instance Method Details

#delete(request_configuration = nil) ⇒ Object

Delete navigation property file for agreements

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of void



38
39
40
41
42
43
44
45
46
 
# File 'lib/agreements/item/file/file_request_builder.rb', line 38

def delete(request_configuration=nil)
    request_info = self.to_delete_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, nil, error_mapping)
end

#get(request_configuration = nil) ⇒ Object

Retrieve the details of the default file for an agreement, including the language and version information. The file information is specified through the agreementFile object.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of agreement_file



52
53
54
55
56
57
58
59
60
 
# File 'lib/agreements/item/file/file_request_builder.rb', line 52

def get(request_configuration=nil)
    request_info = self.to_get_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::AgreementFile.create_from_discriminator_value(pn) }, error_mapping)
end

#localizations ⇒ Object

Provides operations to manage the localizations property of the microsoft.graph.agreementFile entity.



21
22
23
 
# File 'lib/agreements/item/file/file_request_builder.rb', line 21

def localizations()
    return MicrosoftGraph::Agreements::Item::File::Localizations::LocalizationsRequestBuilder.new(@path_parameters, @request_adapter)
end

#localizations_by_id(id) ⇒ Object

Provides operations to manage the localizations property of the microsoft.graph.agreementFile entity.

Parameters:

  • id —

    Unique identifier of the item

Returns:

  • a agreement_file_localization_item_request_builder

Raises:

  • (StandardError) 


66
67
68
69
70
71
 
# File 'lib/agreements/item/file/file_request_builder.rb', line 66

def localizations_by_id(id)
    raise StandardError, 'id cannot be null' if id.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["agreementFileLocalization%2Did"] = id
    return MicrosoftGraph::Agreements::Item::File::Localizations::Item::AgreementFileLocalizationItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#patch(body, request_configuration = nil) ⇒ Object

Update the navigation property file in agreements

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of agreement_file

Raises:

  • (StandardError) 


78
79
80
81
82
83
84
85
86
87
 
# File 'lib/agreements/item/file/file_request_builder.rb', line 78

def patch(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = self.to_patch_request_information(
        body, request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::AgreementFile.create_from_discriminator_value(pn) }, error_mapping)
end

#to_delete_request_information(request_configuration = nil) ⇒ Object

Delete navigation property file for agreements

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/agreements/item/file/file_request_builder.rb', line 93

def to_delete_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :DELETE
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.add_request_options(request_configuration.options)
    end
    return request_info
end

#to_get_request_information(request_configuration = nil) ⇒ Object

Retrieve the details of the default file for an agreement, including the language and version information. The file information is specified through the agreementFile object.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/agreements/item/file/file_request_builder.rb', line 109

def to_get_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :GET
    request_info.headers.add('Accept', 'application/json')
    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
    return request_info
end

#to_patch_request_information(body, request_configuration = nil) ⇒ Object

Update the navigation property file in agreements

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information

Raises:

  • (StandardError) 


128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/agreements/item/file/file_request_builder.rb', line 128

def to_patch_request_information(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :PATCH
    request_info.headers.add('Accept', 'application/json')
    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)
    return request_info
end