@salable/sdk 1.0.23 → 1.0.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.es.js +249 -110
- package/dist/index.es.js.map +1 -1
- package/dist/index.js +249 -110
- package/dist/index.js.map +1 -1
- package/dist/sdk/api/checkout/index.d.ts +2 -2
- package/dist/sdk/api/owners/item/index.d.ts +10 -1
- package/dist/sdk/api/owners/item/portal/index.d.ts +36 -0
- package/dist/sdk/api/subscriptionPlans/index.d.ts +16 -1
- package/dist/sdk/api/subscriptionPlans/item/index.d.ts +16 -1
- package/dist/sdk/api/subscriptions/item/index.d.ts +1 -21
- package/dist/sdk/api/subscriptions/item/portal/index.d.ts +8 -6
- package/dist/sdk/api/usage/record/index.d.ts +2 -2
- package/dist/sdk/models/index.d.ts +600 -190
- package/package.json +1 -1
|
@@ -25,7 +25,7 @@ export interface CheckoutPostRequestBody extends Parsable {
|
|
|
25
25
|
*/
|
|
26
26
|
collectShippingAddress?: boolean | null;
|
|
27
27
|
/**
|
|
28
|
-
* The three-letter ISO currency code (e.g., USD, GBP, EUR). If not provided the checkout will use geolocation. For geolocation to work all line item prices on the plan must have the same default currency.
|
|
28
|
+
* The case-insensitive three-letter ISO 4217 currency code (e.g., USD, GBP, EUR). Input is normalized to canonical uppercase. If not provided the checkout will use geolocation. For geolocation to work all line item prices on the plan must have the same default currency.
|
|
29
29
|
*/
|
|
30
30
|
currency?: CheckoutPostRequestBody_currency | null;
|
|
31
31
|
/**
|
|
@@ -204,7 +204,7 @@ export declare const CheckoutPostRequestBody_cardPrefillPreferenceObject: {
|
|
|
204
204
|
readonly Choice: "choice";
|
|
205
205
|
};
|
|
206
206
|
/**
|
|
207
|
-
* The three-letter ISO currency code (e.g., USD, GBP, EUR). If not provided the checkout will use geolocation. For geolocation to work all line item prices on the plan must have the same default currency.
|
|
207
|
+
* The case-insensitive three-letter ISO 4217 currency code (e.g., USD, GBP, EUR). Input is normalized to canonical uppercase. If not provided the checkout will use geolocation. For geolocation to work all line item prices on the plan must have the same default currency.
|
|
208
208
|
*/
|
|
209
209
|
export declare const CheckoutPostRequestBody_currencyObject: {
|
|
210
210
|
readonly USD: "USD";
|
|
@@ -1,10 +1,15 @@
|
|
|
1
1
|
import { type GetOwnerDetailSchema, type UpdateOwnerRequestSchema } from '../../../models/index.js';
|
|
2
|
-
import { type
|
|
2
|
+
import { type PortalRequestBuilder } from './portal/index.js';
|
|
3
|
+
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
|
|
3
4
|
export type GetExpandQueryParameterType = (typeof GetExpandQueryParameterTypeObject)[keyof typeof GetExpandQueryParameterTypeObject];
|
|
4
5
|
/**
|
|
5
6
|
* Builds and executes requests for operations under /api/owners/{id}
|
|
6
7
|
*/
|
|
7
8
|
export interface OwnersItemRequestBuilder extends BaseRequestBuilder<OwnersItemRequestBuilder> {
|
|
9
|
+
/**
|
|
10
|
+
* The portal property
|
|
11
|
+
*/
|
|
12
|
+
get portal(): PortalRequestBuilder;
|
|
8
13
|
/**
|
|
9
14
|
* Delete Owner
|
|
10
15
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
@@ -79,6 +84,10 @@ export declare const GetExpandQueryParameterTypeObject: {
|
|
|
79
84
|
readonly Subscriptions: "subscriptions";
|
|
80
85
|
readonly Groups: "groups";
|
|
81
86
|
};
|
|
87
|
+
/**
|
|
88
|
+
* Metadata for all the navigation properties in the request builder.
|
|
89
|
+
*/
|
|
90
|
+
export declare const OwnersItemRequestBuilderNavigationMetadata: Record<Exclude<keyof OwnersItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
|
|
82
91
|
/**
|
|
83
92
|
* Metadata for all the requests in the request builder.
|
|
84
93
|
*/
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { type CreateOwnerPortalRequestSchema, type CreateOwnerPortalResponseSchema } from '../../../../models/index.js';
|
|
2
|
+
import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
|
|
3
|
+
/**
|
|
4
|
+
* Builds and executes requests for operations under /api/owners/{id}/portal
|
|
5
|
+
*/
|
|
6
|
+
export interface PortalRequestBuilder extends BaseRequestBuilder<PortalRequestBuilder> {
|
|
7
|
+
/**
|
|
8
|
+
* Creates a Stripe billing portal session for the specified owner, returning a URL to redirect the customer to. The portal is scoped to the owner and shows all subscriptions belonging to that customer. The portal features available are configured per request.
|
|
9
|
+
* @param body The request body
|
|
10
|
+
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
11
|
+
* @returns {Promise<CreateOwnerPortalResponseSchema>}
|
|
12
|
+
* @throws {ErrorResponseBody} error when the service returns a 400 status code
|
|
13
|
+
* @throws {ErrorResponseBody} error when the service returns a 401 status code
|
|
14
|
+
* @throws {ErrorResponseBody} error when the service returns a 403 status code
|
|
15
|
+
* @throws {ErrorResponseBody} error when the service returns a 404 status code
|
|
16
|
+
* @throws {ErrorResponseBody} error when the service returns a 405 status code
|
|
17
|
+
* @throws {ErrorResponseBody} error when the service returns a 429 status code
|
|
18
|
+
* @throws {ErrorResponseBody} error when the service returns a 500 status code
|
|
19
|
+
*/
|
|
20
|
+
post(body: CreateOwnerPortalRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CreateOwnerPortalResponseSchema | undefined>;
|
|
21
|
+
/**
|
|
22
|
+
* Creates a Stripe billing portal session for the specified owner, returning a URL to redirect the customer to. The portal is scoped to the owner and shows all subscriptions belonging to that customer. The portal features available are configured per request.
|
|
23
|
+
* @param body The request body
|
|
24
|
+
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
25
|
+
* @returns {RequestInformation}
|
|
26
|
+
*/
|
|
27
|
+
toPostRequestInformation(body: CreateOwnerPortalRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Uri template for the request builder.
|
|
31
|
+
*/
|
|
32
|
+
export declare const PortalRequestBuilderUriTemplate = "{+baseurl}/api/owners/{id}/portal";
|
|
33
|
+
/**
|
|
34
|
+
* Metadata for all the requests in the request builder.
|
|
35
|
+
*/
|
|
36
|
+
export declare const PortalRequestBuilderRequestsMetadata: RequestsMetadata;
|
|
@@ -6,6 +6,12 @@ import { type AdditionalDataHolder, type BaseRequestBuilder, type KeysToExcludeF
|
|
|
6
6
|
* @returns {SubscriptionPlansGetResponse_data_plan}
|
|
7
7
|
*/
|
|
8
8
|
export declare function createSubscriptionPlansGetResponse_data_planFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
9
|
+
/**
|
|
10
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
11
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
12
|
+
* @returns {string}
|
|
13
|
+
*/
|
|
14
|
+
export declare function createSubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceTypeFromDiscriminatorValue(parseNode: ParseNode | undefined): string | undefined;
|
|
9
15
|
/**
|
|
10
16
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
11
17
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -116,6 +122,14 @@ export declare function serializeSubscriptionPlansGetResponse_data_subscriptionP
|
|
|
116
122
|
* @param writer Serialization writer to use to serialize this model
|
|
117
123
|
*/
|
|
118
124
|
export declare function serializeSubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem(writer: SerializationWriter, subscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem?: Partial<SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
125
|
+
/**
|
|
126
|
+
* Serializes information the current object
|
|
127
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
128
|
+
* @param key The name of the property to write in the serialization.
|
|
129
|
+
* @param SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceType The instance to serialize from.
|
|
130
|
+
* @param writer Serialization writer to use to serialize this model
|
|
131
|
+
*/
|
|
132
|
+
export declare function serializeSubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceType(writer: SerializationWriter, key: string, subscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceType: Parsable | SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceType | undefined, isSerializingDerivedType?: boolean): void;
|
|
119
133
|
export interface SubscriptionPlansGetResponse extends Parsable {
|
|
120
134
|
/**
|
|
121
135
|
* The data property
|
|
@@ -366,7 +380,7 @@ export interface SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_dat
|
|
|
366
380
|
/**
|
|
367
381
|
* The priceType property
|
|
368
382
|
*/
|
|
369
|
-
priceType?:
|
|
383
|
+
priceType?: string | null;
|
|
370
384
|
/**
|
|
371
385
|
* The slug property
|
|
372
386
|
*/
|
|
@@ -388,6 +402,7 @@ export interface SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_dat
|
|
|
388
402
|
*/
|
|
389
403
|
updatedAt?: string | null;
|
|
390
404
|
}
|
|
405
|
+
export type SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceType = string;
|
|
391
406
|
/**
|
|
392
407
|
* Builds and executes requests for operations under /api/subscription-plans
|
|
393
408
|
*/
|
|
@@ -78,6 +78,12 @@ export declare function createSubscriptionPlansGetResponse_data_subscriptionFrom
|
|
|
78
78
|
* @returns {SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_meter}
|
|
79
79
|
*/
|
|
80
80
|
export declare function createSubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_meterFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
|
|
81
|
+
/**
|
|
82
|
+
* Creates a new instance of the appropriate class based on discriminator value
|
|
83
|
+
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
84
|
+
* @returns {string}
|
|
85
|
+
*/
|
|
86
|
+
export declare function createSubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceTypeFromDiscriminatorValue(parseNode: ParseNode | undefined): string | undefined;
|
|
81
87
|
/**
|
|
82
88
|
* Creates a new instance of the appropriate class based on discriminator value
|
|
83
89
|
* @param parseNode The parse node to use to read the discriminator value and create the object
|
|
@@ -451,6 +457,14 @@ export declare function serializeSubscriptionPlansGetResponse_data_subscriptionP
|
|
|
451
457
|
* @param writer Serialization writer to use to serialize this model
|
|
452
458
|
*/
|
|
453
459
|
export declare function serializeSubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_meter(writer: SerializationWriter, subscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_meter?: Partial<SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_meter> | undefined | null, isSerializingDerivedType?: boolean): void;
|
|
460
|
+
/**
|
|
461
|
+
* Serializes information the current object
|
|
462
|
+
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
463
|
+
* @param key The name of the property to write in the serialization.
|
|
464
|
+
* @param SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceType The instance to serialize from.
|
|
465
|
+
* @param writer Serialization writer to use to serialize this model
|
|
466
|
+
*/
|
|
467
|
+
export declare function serializeSubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceType(writer: SerializationWriter, key: string, subscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceType: Parsable | SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceType | undefined, isSerializingDerivedType?: boolean): void;
|
|
454
468
|
/**
|
|
455
469
|
* Serializes information the current object
|
|
456
470
|
* @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
|
|
@@ -947,7 +961,7 @@ export interface SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_dat
|
|
|
947
961
|
/**
|
|
948
962
|
* The priceType property
|
|
949
963
|
*/
|
|
950
|
-
priceType?:
|
|
964
|
+
priceType?: string | null;
|
|
951
965
|
/**
|
|
952
966
|
* The slug property
|
|
953
967
|
*/
|
|
@@ -999,6 +1013,7 @@ export interface SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_dat
|
|
|
999
1013
|
*/
|
|
1000
1014
|
updatedAt?: string | null;
|
|
1001
1015
|
}
|
|
1016
|
+
export type SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_lineItem_priceType = string;
|
|
1002
1017
|
export interface SubscriptionPlansGetResponse_data_subscriptionPlanLineItems_data_usage extends AdditionalDataHolder, Parsable {
|
|
1003
1018
|
/**
|
|
1004
1019
|
* The createdAt property
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type GetSubscriptionDetailSchema
|
|
1
|
+
import { type GetSubscriptionDetailSchema } from '../../../models/index.js';
|
|
2
2
|
import { type AutoRenewRequestBuilder } from './autoRenew/index.js';
|
|
3
3
|
import { type CancelRequestBuilder } from './cancel/index.js';
|
|
4
4
|
import { type InvoicesRequestBuilder } from './invoices/index.js';
|
|
@@ -55,19 +55,6 @@ export interface SubscriptionsItemRequestBuilder extends BaseRequestBuilder<Subs
|
|
|
55
55
|
* @throws {ErrorResponseBody} error when the service returns a 500 status code
|
|
56
56
|
*/
|
|
57
57
|
get(requestConfiguration?: RequestConfiguration<SubscriptionsItemRequestBuilderGetQueryParameters> | undefined): Promise<GetSubscriptionDetailSchema | undefined>;
|
|
58
|
-
/**
|
|
59
|
-
* Updates the interval and intervalCount on a Salable Only subscription. Both fields must be set together or both set to null. Setting both to null removes the interval from the subscription, which is only permitted if the subscription has no metered line items.
|
|
60
|
-
* @param body The request body
|
|
61
|
-
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
62
|
-
* @throws {ErrorResponseBody} error when the service returns a 400 status code
|
|
63
|
-
* @throws {ErrorResponseBody} error when the service returns a 401 status code
|
|
64
|
-
* @throws {ErrorResponseBody} error when the service returns a 403 status code
|
|
65
|
-
* @throws {ErrorResponseBody} error when the service returns a 404 status code
|
|
66
|
-
* @throws {ErrorResponseBody} error when the service returns a 405 status code
|
|
67
|
-
* @throws {ErrorResponseBody} error when the service returns a 429 status code
|
|
68
|
-
* @throws {ErrorResponseBody} error when the service returns a 500 status code
|
|
69
|
-
*/
|
|
70
|
-
put(body: UpdateSalableOnlySubscriptionRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
|
|
71
58
|
/**
|
|
72
59
|
* Permanently deletes a subscription. This endpoint is only available in test mode. For recurring subscriptions that are not already canceled, this will first cancel the subscription on Stripe before deleting it.
|
|
73
60
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
@@ -80,13 +67,6 @@ export interface SubscriptionsItemRequestBuilder extends BaseRequestBuilder<Subs
|
|
|
80
67
|
* @returns {RequestInformation}
|
|
81
68
|
*/
|
|
82
69
|
toGetRequestInformation(requestConfiguration?: RequestConfiguration<SubscriptionsItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
|
|
83
|
-
/**
|
|
84
|
-
* Updates the interval and intervalCount on a Salable Only subscription. Both fields must be set together or both set to null. Setting both to null removes the interval from the subscription, which is only permitted if the subscription has no metered line items.
|
|
85
|
-
* @param body The request body
|
|
86
|
-
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
87
|
-
* @returns {RequestInformation}
|
|
88
|
-
*/
|
|
89
|
-
toPutRequestInformation(body: UpdateSalableOnlySubscriptionRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
|
|
90
70
|
}
|
|
91
71
|
/**
|
|
92
72
|
* Retrieves the details of a subscription.
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import { type
|
|
1
|
+
import { type CreateSubscriptionPortalRequestSchema, type CreateSubscriptionPortalResponseSchema } from '../../../../models/index.js';
|
|
2
2
|
import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
|
|
3
3
|
/**
|
|
4
4
|
* Builds and executes requests for operations under /api/subscriptions/{id}/portal
|
|
5
5
|
*/
|
|
6
6
|
export interface PortalRequestBuilder extends BaseRequestBuilder<PortalRequestBuilder> {
|
|
7
7
|
/**
|
|
8
|
-
* Creates a Stripe billing portal session for the specified subscription, returning a URL to redirect the customer to. The portal features available are configured per request.
|
|
8
|
+
* **Deprecated — use [POST /api/owners/{id}/portal](#tag/owners/POST/api/owners/{id}/portal) instead.**Creates a Stripe billing portal session for the specified subscription, returning a URL to redirect the customer to. The portal features available are configured per request.
|
|
9
9
|
* @param body The request body
|
|
10
10
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
11
|
-
* @returns {Promise<
|
|
11
|
+
* @returns {Promise<CreateSubscriptionPortalResponseSchema>}
|
|
12
12
|
* @throws {ErrorResponseBody} error when the service returns a 400 status code
|
|
13
13
|
* @throws {ErrorResponseBody} error when the service returns a 401 status code
|
|
14
14
|
* @throws {ErrorResponseBody} error when the service returns a 403 status code
|
|
@@ -16,15 +16,17 @@ export interface PortalRequestBuilder extends BaseRequestBuilder<PortalRequestBu
|
|
|
16
16
|
* @throws {ErrorResponseBody} error when the service returns a 405 status code
|
|
17
17
|
* @throws {ErrorResponseBody} error when the service returns a 429 status code
|
|
18
18
|
* @throws {ErrorResponseBody} error when the service returns a 500 status code
|
|
19
|
+
* @deprecated
|
|
19
20
|
*/
|
|
20
|
-
post(body:
|
|
21
|
+
post(body: CreateSubscriptionPortalRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CreateSubscriptionPortalResponseSchema | undefined>;
|
|
21
22
|
/**
|
|
22
|
-
* Creates a Stripe billing portal session for the specified subscription, returning a URL to redirect the customer to. The portal features available are configured per request.
|
|
23
|
+
* **Deprecated — use [POST /api/owners/{id}/portal](#tag/owners/POST/api/owners/{id}/portal) instead.**Creates a Stripe billing portal session for the specified subscription, returning a URL to redirect the customer to. The portal features available are configured per request.
|
|
23
24
|
* @param body The request body
|
|
24
25
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
25
26
|
* @returns {RequestInformation}
|
|
27
|
+
* @deprecated
|
|
26
28
|
*/
|
|
27
|
-
toPostRequestInformation(body:
|
|
29
|
+
toPostRequestInformation(body: CreateSubscriptionPortalRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
|
|
28
30
|
}
|
|
29
31
|
/**
|
|
30
32
|
* Uri template for the request builder.
|
|
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
|
|
|
5
5
|
*/
|
|
6
6
|
export interface RecordRequestBuilder extends BaseRequestBuilder<RecordRequestBuilder> {
|
|
7
7
|
/**
|
|
8
|
-
* Increment usage on a line item for an owner. The request will be sent to a queue where it will be processed.
|
|
8
|
+
* Increment usage on a line item for an owner. The request will be sent to a queue where it will be processed. Use /usage-records to confirm the usage was incremented.
|
|
9
9
|
* @param body The request body
|
|
10
10
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
11
11
|
* @throws {ErrorResponseBody} error when the service returns a 400 status code
|
|
@@ -19,7 +19,7 @@ export interface RecordRequestBuilder extends BaseRequestBuilder<RecordRequestBu
|
|
|
19
19
|
*/
|
|
20
20
|
post(body: RecordUsageRequestSchema, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
|
|
21
21
|
/**
|
|
22
|
-
* Increment usage on a line item for an owner. The request will be sent to a queue where it will be processed.
|
|
22
|
+
* Increment usage on a line item for an owner. The request will be sent to a queue where it will be processed. Use /usage-records to confirm the usage was incremented.
|
|
23
23
|
* @param body The request body
|
|
24
24
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
25
25
|
* @returns {RequestInformation}
|