com.microsoft.graph.generated.users.item.authentication.phonemethods.PhoneMethodsRequestBuilder Maven / Gradle / Ivy
package com.microsoft.graph.users.item.authentication.phonemethods;
import com.microsoft.graph.models.odataerrors.ODataError;
import com.microsoft.graph.models.PhoneAuthenticationMethod;
import com.microsoft.graph.models.PhoneAuthenticationMethodCollectionResponse;
import com.microsoft.graph.users.item.authentication.phonemethods.count.CountRequestBuilder;
import com.microsoft.graph.users.item.authentication.phonemethods.item.PhoneAuthenticationMethodItemRequestBuilder;
import com.microsoft.kiota.BaseRequestBuilder;
import com.microsoft.kiota.BaseRequestConfiguration;
import com.microsoft.kiota.HttpMethod;
import com.microsoft.kiota.QueryParameters;
import com.microsoft.kiota.RequestAdapter;
import com.microsoft.kiota.RequestInformation;
import com.microsoft.kiota.RequestOption;
import com.microsoft.kiota.serialization.Parsable;
import com.microsoft.kiota.serialization.ParsableFactory;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
/**
* Provides operations to manage the phoneMethods property of the microsoft.graph.authentication entity.
*/
@jakarta.annotation.Generated("com.microsoft.kiota")
public class PhoneMethodsRequestBuilder extends BaseRequestBuilder {
/**
* Provides operations to count the resources in the collection.
* @return a {@link CountRequestBuilder}
*/
@jakarta.annotation.Nonnull
public CountRequestBuilder count() {
return new CountRequestBuilder(pathParameters, requestAdapter);
}
/**
* Provides operations to manage the phoneMethods property of the microsoft.graph.authentication entity.
* @param phoneAuthenticationMethodId The unique identifier of phoneAuthenticationMethod
* @return a {@link PhoneAuthenticationMethodItemRequestBuilder}
*/
@jakarta.annotation.Nonnull
public PhoneAuthenticationMethodItemRequestBuilder byPhoneAuthenticationMethodId(@jakarta.annotation.Nonnull final String phoneAuthenticationMethodId) {
Objects.requireNonNull(phoneAuthenticationMethodId);
final HashMap urlTplParams = new HashMap(this.pathParameters);
urlTplParams.put("phoneAuthenticationMethod%2Did", phoneAuthenticationMethodId);
return new PhoneAuthenticationMethodItemRequestBuilder(urlTplParams, requestAdapter);
}
/**
* Instantiates a new {@link PhoneMethodsRequestBuilder} and sets the default values.
* @param pathParameters Path parameters for the request
* @param requestAdapter The request adapter to use to execute the requests.
*/
public PhoneMethodsRequestBuilder(@jakarta.annotation.Nonnull final HashMap pathParameters, @jakarta.annotation.Nonnull final RequestAdapter requestAdapter) {
super(requestAdapter, "{+baseurl}/users/{user%2Did}/authentication/phoneMethods{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}", pathParameters);
}
/**
* Instantiates a new {@link PhoneMethodsRequestBuilder} and sets the default values.
* @param rawUrl The raw URL to use for the request builder.
* @param requestAdapter The request adapter to use to execute the requests.
*/
public PhoneMethodsRequestBuilder(@jakarta.annotation.Nonnull final String rawUrl, @jakarta.annotation.Nonnull final RequestAdapter requestAdapter) {
super(requestAdapter, "{+baseurl}/users/{user%2Did}/authentication/phoneMethods{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}", rawUrl);
}
/**
* The phone numbers registered to a user for authentication.
* @return a {@link PhoneAuthenticationMethodCollectionResponse}
* @throws ODataError When receiving a 4XX or 5XX status code
*/
@jakarta.annotation.Nullable
public PhoneAuthenticationMethodCollectionResponse get() {
return get(null);
}
/**
* The phone numbers registered to a user for authentication.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @return a {@link PhoneAuthenticationMethodCollectionResponse}
* @throws ODataError When receiving a 4XX or 5XX status code
*/
@jakarta.annotation.Nullable
public PhoneAuthenticationMethodCollectionResponse get(@jakarta.annotation.Nullable final java.util.function.Consumer requestConfiguration) {
final RequestInformation requestInfo = toGetRequestInformation(requestConfiguration);
final HashMap> errorMapping = new HashMap>();
errorMapping.put("XXX", ODataError::createFromDiscriminatorValue);
return this.requestAdapter.send(requestInfo, errorMapping, PhoneAuthenticationMethodCollectionResponse::createFromDiscriminatorValue);
}
/**
* Add a new phone authentication method for a user. A user may only have one phone of each type, captured in the phoneType property. This means, for example, adding a mobile phone to a user with a pre-existing mobile phone fails. Additionally, a user must always have a mobile phone before adding an alternateMobile phone. Adding a phone number makes it available for use in both Azure multi-factor authentication (MFA) and self-service password reset (SSPR), if enabled. Additionally, if a user is enabled by policy to use SMS sign-in and a mobile number is added, the system attempts to register the number for use in that system.
* @param body The request body
* @return a {@link PhoneAuthenticationMethod}
* @throws ODataError When receiving a 4XX or 5XX status code
* @see Find more info here
*/
@jakarta.annotation.Nullable
public PhoneAuthenticationMethod post(@jakarta.annotation.Nonnull final PhoneAuthenticationMethod body) {
return post(body, null);
}
/**
* Add a new phone authentication method for a user. A user may only have one phone of each type, captured in the phoneType property. This means, for example, adding a mobile phone to a user with a pre-existing mobile phone fails. Additionally, a user must always have a mobile phone before adding an alternateMobile phone. Adding a phone number makes it available for use in both Azure multi-factor authentication (MFA) and self-service password reset (SSPR), if enabled. Additionally, if a user is enabled by policy to use SMS sign-in and a mobile number is added, the system attempts to register the number for use in that system.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @return a {@link PhoneAuthenticationMethod}
* @throws ODataError When receiving a 4XX or 5XX status code
* @see Find more info here
*/
@jakarta.annotation.Nullable
public PhoneAuthenticationMethod post(@jakarta.annotation.Nonnull final PhoneAuthenticationMethod body, @jakarta.annotation.Nullable final java.util.function.Consumer requestConfiguration) {
Objects.requireNonNull(body);
final RequestInformation requestInfo = toPostRequestInformation(body, requestConfiguration);
final HashMap> errorMapping = new HashMap>();
errorMapping.put("XXX", ODataError::createFromDiscriminatorValue);
return this.requestAdapter.send(requestInfo, errorMapping, PhoneAuthenticationMethod::createFromDiscriminatorValue);
}
/**
* The phone numbers registered to a user for authentication.
* @return a {@link RequestInformation}
*/
@jakarta.annotation.Nonnull
public RequestInformation toGetRequestInformation() {
return toGetRequestInformation(null);
}
/**
* The phone numbers registered to a user for authentication.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @return a {@link RequestInformation}
*/
@jakarta.annotation.Nonnull
public RequestInformation toGetRequestInformation(@jakarta.annotation.Nullable final java.util.function.Consumer requestConfiguration) {
final RequestInformation requestInfo = new RequestInformation(HttpMethod.GET, urlTemplate, pathParameters);
requestInfo.configure(requestConfiguration, GetRequestConfiguration::new, x -> x.queryParameters);
requestInfo.headers.tryAdd("Accept", "application/json");
return requestInfo;
}
/**
* Add a new phone authentication method for a user. A user may only have one phone of each type, captured in the phoneType property. This means, for example, adding a mobile phone to a user with a pre-existing mobile phone fails. Additionally, a user must always have a mobile phone before adding an alternateMobile phone. Adding a phone number makes it available for use in both Azure multi-factor authentication (MFA) and self-service password reset (SSPR), if enabled. Additionally, if a user is enabled by policy to use SMS sign-in and a mobile number is added, the system attempts to register the number for use in that system.
* @param body The request body
* @return a {@link RequestInformation}
*/
@jakarta.annotation.Nonnull
public RequestInformation toPostRequestInformation(@jakarta.annotation.Nonnull final PhoneAuthenticationMethod body) {
return toPostRequestInformation(body, null);
}
/**
* Add a new phone authentication method for a user. A user may only have one phone of each type, captured in the phoneType property. This means, for example, adding a mobile phone to a user with a pre-existing mobile phone fails. Additionally, a user must always have a mobile phone before adding an alternateMobile phone. Adding a phone number makes it available for use in both Azure multi-factor authentication (MFA) and self-service password reset (SSPR), if enabled. Additionally, if a user is enabled by policy to use SMS sign-in and a mobile number is added, the system attempts to register the number for use in that system.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @return a {@link RequestInformation}
*/
@jakarta.annotation.Nonnull
public RequestInformation toPostRequestInformation(@jakarta.annotation.Nonnull final PhoneAuthenticationMethod body, @jakarta.annotation.Nullable final java.util.function.Consumer requestConfiguration) {
Objects.requireNonNull(body);
final RequestInformation requestInfo = new RequestInformation(HttpMethod.POST, urlTemplate, pathParameters);
requestInfo.configure(requestConfiguration, PostRequestConfiguration::new);
requestInfo.headers.tryAdd("Accept", "application/json");
requestInfo.setContentFromParsable(requestAdapter, "application/json", body);
return requestInfo;
}
/**
* Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
* @param rawUrl The raw URL to use for the request builder.
* @return a {@link PhoneMethodsRequestBuilder}
*/
@jakarta.annotation.Nonnull
public PhoneMethodsRequestBuilder withUrl(@jakarta.annotation.Nonnull final String rawUrl) {
Objects.requireNonNull(rawUrl);
return new PhoneMethodsRequestBuilder(rawUrl, requestAdapter);
}
/**
* The phone numbers registered to a user for authentication.
*/
@jakarta.annotation.Generated("com.microsoft.kiota")
public class GetQueryParameters implements QueryParameters {
/**
* Include count of items
*/
@jakarta.annotation.Nullable
public Boolean count;
/**
* Expand related entities
*/
@jakarta.annotation.Nullable
public String[] expand;
/**
* Filter items by property values
*/
@jakarta.annotation.Nullable
public String filter;
/**
* Order items by property values
*/
@jakarta.annotation.Nullable
public String[] orderby;
/**
* Search items by search phrases
*/
@jakarta.annotation.Nullable
public String search;
/**
* Select properties to be returned
*/
@jakarta.annotation.Nullable
public String[] select;
/**
* Skip the first n items
*/
@jakarta.annotation.Nullable
public Integer skip;
/**
* Show only the first n items
*/
@jakarta.annotation.Nullable
public Integer top;
/**
* Extracts the query parameters into a map for the URI template parsing.
* @return a {@link Map}
*/
@jakarta.annotation.Nonnull
public Map toQueryParameters() {
final Map allQueryParams = new HashMap();
allQueryParams.put("%24count", count);
allQueryParams.put("%24filter", filter);
allQueryParams.put("%24search", search);
allQueryParams.put("%24skip", skip);
allQueryParams.put("%24top", top);
allQueryParams.put("%24expand", expand);
allQueryParams.put("%24orderby", orderby);
allQueryParams.put("%24select", select);
return allQueryParams;
}
}
/**
* Configuration for the request such as headers, query parameters, and middleware options.
*/
@jakarta.annotation.Generated("com.microsoft.kiota")
public class GetRequestConfiguration extends BaseRequestConfiguration {
/**
* Request query parameters
*/
@jakarta.annotation.Nullable
public GetQueryParameters queryParameters = new GetQueryParameters();
}
/**
* Configuration for the request such as headers, query parameters, and middleware options.
*/
@jakarta.annotation.Generated("com.microsoft.kiota")
public class PostRequestConfiguration extends BaseRequestConfiguration {
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy