@contiva/sap-integration-suite-client
Version:
SAP Cloud Platform Integration API Client
838 lines (837 loc) • 33.7 kB
TypeScript
export type ComSapHciApiUserCredentialParameter = ComSapHciApiParameter & {
/** @maxLength 200 */
User?: string;
/**
* @maxLength 200
* @example ""
*/
Password?: string | null;
};
export type ComSapHciApiUserCredentialParameterCreate = ComSapHciApiParameterCreate & {
/** @maxLength 200 */
User?: string;
/**
* @maxLength 200
* @example "password"
*/
Password?: string | null;
};
export type ComSapHciApiStringParameter = ComSapHciApiParameter & {
/** @maxLength 4000 */
Value?: string;
/** @maxLength 150 */
LastModifiedBy?: string | null;
};
export type ComSapHciApiStringParameterCreate = ComSapHciApiParameterCreate & {
/** @maxLength 4000 */
Value?: string;
};
/** StringParameter (for update) */
export interface ComSapHciApiStringParameterUpdate {
/** @maxLength 4000 */
Value?: string;
}
export type ComSapHciApiStringConfigurationParameter = ComSapHciApiConfigurationParameter & {
/** @maxLength 1500 */
Value?: string;
};
export type ComSapHciApiStringConfigurationParameterCreate = ComSapHciApiConfigurationParameterCreate & {
/** @maxLength 1500 */
Value?: string;
};
export type ComSapHciApiStringConfigurationParameterUpdate = ComSapHciApiConfigurationParameterUpdate & {
/** @maxLength 1500 */
Value?: string;
};
/** AlternativePartner */
export interface ComSapHciApiAlternativePartner {
/** @maxLength 480 */
Hexagency?: string;
/** @maxLength 480 */
Hexscheme?: string;
/** @maxLength 240 */
Hexid?: string;
/** @maxLength 120 */
Agency?: string;
/** @maxLength 120 */
Scheme?: string;
/** @maxLength 60 */
Id?: string;
/** @maxLength 60 */
Pid?: string;
/** @maxLength 150 */
LastModifiedBy?: string | null;
/**
* @format date-time
* @example "2017-04-13T15:51:04"
*/
LastModifiedTime?: string | null;
/** @maxLength 150 */
CreatedBy?: string | null;
/**
* @format date-time
* @example "2017-04-13T15:51:04"
*/
CreatedTime?: string | null;
}
/** AlternativePartner (for create) */
export interface ComSapHciApiAlternativePartnerCreate {
/** @maxLength 120 */
Agency?: string;
/** @maxLength 120 */
Scheme?: string;
/** @maxLength 60 */
Id?: string;
/** @maxLength 60 */
Pid?: string;
}
/** AlternativePartner (for update) */
export interface ComSapHciApiAlternativePartnerUpdate {
/** @maxLength 60 */
Pid?: string;
}
export type ComSapHciApiBinaryParameter = ComSapHciApiParameter & {
/** @maxLength 300 */
ContentType?: string;
/**
* @format base64url
* @maxLength 262144
*/
Value?: string;
};
export type ComSapHciApiBinaryParameterCreate = ComSapHciApiParameterCreate & {
/** @maxLength 300 */
ContentType?: string;
/**
* @format base64url
* @maxLength 262144
*/
Value?: string;
};
/** BinaryParameter (for update) */
export interface ComSapHciApiBinaryParameterUpdate {
/** @maxLength 300 */
ContentType?: string;
/**
* @format base64url
* @maxLength 262144
*/
Value?: string;
}
/** Partner */
export interface ComSapHciApiPartner {
/** @maxLength 60 */
Pid?: string;
}
/** AuthorizedUser */
export interface ComSapHciApiAuthorizedUser {
/** @maxLength 150 */
User?: string;
/** @maxLength 60 */
Pid?: string;
/** @maxLength 150 */
LastModifiedBy?: string | null;
/**
* @format date-time
* @example "2017-04-13T15:51:04"
*/
LastModifiedTime?: string | null;
/** @maxLength 150 */
CreatedBy?: string | null;
/**
* @format date-time
* @example "2017-04-13T15:51:04"
*/
CreatedTime?: string | null;
}
/** AuthorizedUser (for create) */
export interface ComSapHciApiAuthorizedUserCreate {
/** @maxLength 150 */
User?: string;
/** @maxLength 60 */
Pid?: string;
}
/** AuthorizedUser (for update) */
export interface ComSapHciApiAuthorizedUserUpdate {
/** @maxLength 60 */
Pid?: string;
}
/** ConfigurationParameter */
export interface ComSapHciApiConfigurationParameter {
/** @maxLength 90 */
Name?: string;
/** @maxLength 150 */
Namespace?: string;
/** @maxLength 150 */
LastModifiedBy?: string | null;
/**
* @format date-time
* @example "2017-04-13T15:51:04"
*/
LastModifiedTime?: string | null;
/** @maxLength 150 */
CreatedBy?: string | null;
/**
* @format date-time
* @example "2017-04-13T15:51:04"
*/
CreatedTime?: string | null;
}
/** ConfigurationParameter (for create) */
export interface ComSapHciApiConfigurationParameterCreate {
/** @maxLength 90 */
Name?: string;
/** @maxLength 150 */
Namespace?: string;
}
/** ConfigurationParameter (for update) */
export interface ComSapHciApiConfigurationParameterUpdate {
/** @maxLength 90 */
Name?: string;
/** @maxLength 150 */
Namespace?: string;
}
/** Parameter */
export interface ComSapHciApiParameter {
/** @maxLength 60 */
Pid?: string;
/** @maxLength 1500 */
Id?: string;
/** @maxLength 150 */
LastModifiedBy?: string | null;
/**
* @format date-time
* @example "2017-04-13T15:51:04"
*/
LastModifiedTime?: string | null;
/** @maxLength 150 */
CreatedBy?: string | null;
/**
* @format date-time
* @example "2017-04-13T15:51:04"
*/
CreatedTime?: string | null;
}
/** Parameter (for create) */
export interface ComSapHciApiParameterCreate {
/** @maxLength 60 */
Pid?: string;
/** @maxLength 1500 */
Id?: string;
}
/** Parameter (for update) */
export interface ComSapHciApiParameterUpdate {
/** @maxLength 60 */
Pid?: string;
/** @maxLength 1500 */
Id?: string;
}
export interface ComSapHciApiSandboxError {
code?: string;
message?: string;
}
export interface OdataError {
error: OdataErrorMain;
}
export interface OdataErrorMain {
code: string;
message: {
lang: string;
value: string;
};
}
export interface OdataErrorDetail {
code: string;
message: string;
target?: string;
}
export type QueryParamsType = Record<string | number, any>;
export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
export interface FullRequestParams extends Omit<RequestInit, "body"> {
/** set parameter to `true` for call `securityWorker` for this request */
secure?: boolean;
/** request path */
path: string;
/** content type of request body */
type?: ContentType;
/** query params */
query?: QueryParamsType;
/** format of response (i.e. response.json() -> format: "json") */
format?: ResponseFormat;
/** request body */
body?: unknown;
/** base url */
baseUrl?: string;
/** request cancellation token */
cancelToken?: CancelToken;
}
export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
export interface ApiConfig<SecurityDataType = unknown> {
baseUrl?: string;
baseApiParams?: Omit<RequestParams, "baseUrl" | "cancelToken" | "signal">;
securityWorker?: (securityData: SecurityDataType | null) => Promise<RequestParams | void> | RequestParams | void;
customFetch?: typeof fetch;
}
export interface HttpResponse<D extends unknown, E extends unknown = unknown> extends Response {
data: D;
error: E;
}
type CancelToken = Symbol | string | number;
export declare enum ContentType {
Json = "application/json",
JsonApi = "application/vnd.api+json",
FormData = "multipart/form-data",
UrlEncoded = "application/x-www-form-urlencoded",
Text = "text/plain"
}
export declare class HttpClient<SecurityDataType = unknown> {
baseUrl: string;
private securityData;
private securityWorker?;
private abortControllers;
private customFetch;
private baseApiParams;
constructor(apiConfig?: ApiConfig<SecurityDataType>);
setSecurityData: (data: SecurityDataType | null) => void;
protected encodeQueryParam(key: string, value: any): string;
protected addQueryParam(query: QueryParamsType, key: string): string;
protected addArrayQueryParam(query: QueryParamsType, key: string): any;
protected toQueryString(rawQuery?: QueryParamsType): string;
protected addQueryParams(rawQuery?: QueryParamsType): string;
private contentFormatters;
protected mergeRequestParams(params1: RequestParams, params2?: RequestParams): RequestParams;
protected createAbortSignal: (cancelToken: CancelToken) => AbortSignal | undefined;
abortRequest: (cancelToken: CancelToken) => void;
request: <T = any, E = any>({ body, secure, path, type, query, format, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
}
/**
* @title Partner Directory
* @version 1.0.0
* @baseUrl https://{Account Short Name}-tmn.{SSL Host}.{landscapehost}/api/v1
* @externalDocs https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/0fe80dc9d3be4dfbbb89ee4c791d326e.html
*
* Partner Directory enables you to get, write or delete data. This component contains information on partners that are connected to a tenant in the context of a larger network. Information stored in the Partner Directory can be used to parameterize integration flows.
* This API is implemented based on OData version 2 specification.
*/
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
/**
* @description You can use the following request to request the CSRF token for this session, which is required for write access via POST, PUT and DELETE operations. Copy the received X-CSRF-Token from the response header.<br> **In API sandbox this request is not relevant!**
*
* @tags CSRF Token Handling
* @name GetRoot
* @summary Get CSRF token.
* @request GET:/
* @secure
*/
getRoot: (params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
alternativePartners: {
/**
* @description You can use the following request to get all alternative partners.
*
* @tags Alternative Partners
* @name AlternativePartnersList
* @summary Get all alternative partners.
* @request GET:/AlternativePartners
* @secure
*/
alternativePartnersList: (query?: {
/**
* Show only the first n items.
* @min 0
*/
$top?: number;
/**
* Skip the first n items.
* @min 0
*/
$skip?: number;
/** Filter items by property values. */
$filter?: string;
/**
* Order items by property values
* @uniqueItems true
*/
$orderby?: ("Hexagency" | "Hexagency desc" | "Hexscheme" | "Hexscheme desc" | "Hexid" | "Hexid desc" | "Agency" | "Agency desc" | "Scheme" | "Scheme desc" | "Id" | "Id desc" | "Pid" | "Pid desc" | "LastModifiedBy" | "LastModifiedBy desc" | "LastModifiedTime" | "LastModifiedTime desc" | "CreatedBy" | "CreatedBy desc" | "CreatedTime" | "CreatedTime desc")[];
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("Hexagency" | "Hexscheme" | "Hexid" | "Agency" | "Scheme" | "Id" | "Pid" | "LastModifiedBy" | "LastModifiedTime" | "CreatedBy" | "CreatedTime")[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiAlternativePartner[];
};
}, OdataError>>;
/**
* @description You can use the following request to add new alternative partner.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags Alternative Partners
* @name AlternativePartnersCreate
* @summary Add new alternative partner.
* @request POST:/AlternativePartners
* @secure
*/
alternativePartnersCreate: (AlternativePartner: ComSapHciApiAlternativePartnerCreate, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiAlternativePartner, void | OdataError>>;
};
alternativePartnersHexagencyHexagencyHexschemeHexschemeHexidHexid: {
/**
* @description You can use the following request to get an alternative partner by key fields.
*
* @tags Alternative Partners
* @name AlternativePartnersHexagencyHexschemeHexidList
* @summary Get alternative partner by key fields.
* @request GET:/AlternativePartners(Hexagency='{Hexagency}',Hexscheme='{Hexscheme}',Hexid='{Hexid}')
* @secure
*/
alternativePartnersHexagencyHexschemeHexidList: (hexagency: string, hexscheme: string, hexid: string, query?: {
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("Agency" | "Scheme" | "Id" | "Pid" | "LastModifiedBy" | "LastModifiedTime" | "CreatedBy" | "CreatedTime")[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiAlternativePartner;
}, OdataError>>;
/**
* @description You can use the following request to update alternative partner.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags Alternative Partners
* @name AlternativePartnersHexagencyHexschemeHexidUpdate
* @summary Update alternative partner.
* @request PUT:/AlternativePartners(Hexagency='{Hexagency}',Hexscheme='{Hexscheme}',Hexid='{Hexid}')
* @secure
*/
alternativePartnersHexagencyHexschemeHexidUpdate: (hexagency: string, hexscheme: string, hexid: string, AlternativePartner: ComSapHciApiAlternativePartnerUpdate, params?: RequestParams) => Promise<HttpResponse<any, void | OdataError>>;
/**
* @description You can use the following request to delete alternative partner.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags Alternative Partners
* @name AlternativePartnersHexagencyHexschemeHexidDelete
* @summary Delete alternative partner.
* @request DELETE:/AlternativePartners(Hexagency='{Hexagency}',Hexscheme='{Hexscheme}',Hexid='{Hexid}')
* @secure
*/
alternativePartnersHexagencyHexschemeHexidDelete: (hexagency: string, hexscheme: string, hexid: string, params?: RequestParams) => Promise<HttpResponse<any, void | OdataError>>;
};
authorizedUsers: {
/**
* @description You can use the following request to get all authorized users.
*
* @tags Authorized Users
* @name AuthorizedUsersList
* @summary Get all authorized users.
* @request GET:/AuthorizedUsers
* @secure
*/
authorizedUsersList: (query?: {
/** User which initiates the call */
user?: string;
/**
* Show only the first n items.
* @min 0
*/
$top?: number;
/**
* Skip the first n items.
* @min 0
*/
$skip?: number;
/** Filter items by property values. */
$filter?: string;
/**
* Order items by property values.
* @uniqueItems true
*/
$orderby?: ("User" | "User desc" | "Pid" | "Pid desc" | "LastModifiedBy" | "LastModifiedBy desc" | "LastModifiedTime" | "LastModifiedTime desc" | "CreatedBy" | "CreatedBy desc" | "CreatedTime" | "CreatedTime desc")[];
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("User" | "Pid" | "LastModifiedBy" | "LastModifiedTime" | "CreatedBy" | "CreatedTime")[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiAuthorizedUser[];
};
}, OdataError>>;
/**
* @description You can use the following request to add new authorized user.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags Authorized Users
* @name AuthorizedUsersCreate
* @summary Add new authorized user.
* @request POST:/AuthorizedUsers
* @secure
*/
authorizedUsersCreate: (AuthorizedUser: ComSapHciApiAuthorizedUserCreate, query?: {
/** User which initiates the call */
user?: string;
}, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiAuthorizedUser, void | OdataError>>;
};
authorizedUsersUser: {
/**
* @description You can use the following request to get an authorized user by key.
*
* @tags Authorized Users
* @name AuthorizedUsersList
* @summary Get authorized user by key.
* @request GET:/AuthorizedUsers('{User}')
* @secure
*/
authorizedUsersList: (user: string, query?: {
/** User which initiates the call */
user?: string;
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("Pid" | "LastModifiedBy" | "LastModifiedTime" | "CreatedBy" | "CreatedTime")[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiAuthorizedUser;
}, OdataError>>;
/**
* @description You can use the following request to update authorized user.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags Authorized Users
* @name AuthorizedUsersUpdate
* @summary Update authorized user.
* @request PUT:/AuthorizedUsers('{User}')
* @secure
*/
authorizedUsersUpdate: (user: string, AuthorizedUser: ComSapHciApiAuthorizedUserUpdate, query?: {
/** User which initiates the call */
user?: string;
}, params?: RequestParams) => Promise<HttpResponse<any, void | OdataError>>;
/**
* @description You can use the following request to delete authorized users.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags Authorized Users
* @name AuthorizedUsersDelete
* @summary Delete authorized users.
* @request DELETE:/AuthorizedUsers('{User}')
* @secure
*/
authorizedUsersDelete: (user: string, query?: {
/** User which initiates the call */
user?: string;
}, params?: RequestParams) => Promise<HttpResponse<any, OdataError>>;
};
binaryParameters: {
/**
* @description You can use the following request to get all binary parameters.
*
* @tags Binary Parameters
* @name BinaryParametersList
* @summary Get all binary parameters.
* @request GET:/BinaryParameters
* @secure
*/
binaryParametersList: (query?: {
/** User which initiates the call */
user?: string;
/**
* Show only the first n items.
* @min 0
*/
$top?: number;
/**
* Skip the first n items.
* @min 0
*/
$skip?: number;
/** Filter items by property values. */
$filter?: string;
/**
* Order items by property values
* @uniqueItems true
*/
$orderby?: ("ContentType" | "ContentType desc" | "Value" | "Value desc")[];
/**
* Select properties to be returned
* @uniqueItems true
*/
$select?: ("ContentType" | "Value")[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiBinaryParameter[];
};
}, OdataError>>;
/**
* @description You can use the following request to add a new binary parameter.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags Binary Parameters
* @name BinaryParametersCreate
* @summary Add a new binary parameter.
* @request POST:/BinaryParameters
* @secure
*/
binaryParametersCreate: (BinaryParameter: ComSapHciApiBinaryParameterCreate, query?: {
/** User which initiates the call */
user?: string;
}, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiBinaryParameter, void | OdataError>>;
};
binaryParametersPidPidIdId: {
/**
* @description You can use the following request to get a binary parameter by key.
*
* @tags Binary Parameters
* @name BinaryParametersPidIdList
* @summary Get binary parameter by key
* @request GET:/BinaryParameters(Pid='{Pid}',Id='{Id}')
* @secure
*/
binaryParametersPidIdList: (pid: string, id: string, query?: {
/** User which initiates the call */
user?: string;
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("ContentType" | "Value")[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiBinaryParameter;
}, OdataError>>;
/**
* @description You can use the following request to update binary parameter by key.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags Binary Parameters
* @name BinaryParametersPidIdUpdate
* @summary Update binary parameter by key.
* @request PUT:/BinaryParameters(Pid='{Pid}',Id='{Id}')
* @secure
*/
binaryParametersPidIdUpdate: (pid: string, id: string, BinaryParameter: ComSapHciApiBinaryParameterUpdate, query?: {
/** User which initiates the call */
user?: string;
}, params?: RequestParams) => Promise<HttpResponse<any, void | OdataError>>;
/**
* @description You can use the following request to delete binary parameter.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags Binary Parameters
* @name BinaryParametersPidIdDelete
* @summary Delete binary parameter.
* @request DELETE:/BinaryParameters(Pid='{Pid}',Id='{Id}')
* @secure
*/
binaryParametersPidIdDelete: (pid: string, id: string, query?: {
/** User which initiates the call */
user?: string;
}, params?: RequestParams) => Promise<HttpResponse<any, OdataError>>;
};
partners: {
/**
* @description You can use the following request to get all partners.
*
* @tags Partners
* @name PartnersList
* @summary Get all partners.
* @request GET:/Partners
* @secure
*/
partnersList: (query?: {
/** User which initiates the call */
user?: string;
}, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiPartner[];
};
}, OdataError>>;
};
partnersPid: {
/**
* @description You can use the following request to delete partner.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags Partners
* @name PartnersDelete
* @summary Delete partner.
* @request DELETE:/Partners('{Pid}')
* @secure
*/
partnersDelete: (pid: string, query?: {
/**
* Exclude certain entity types from deletion
* @uniqueItems false
*/
exclude?: ("AuthorizedUsers" | "AlternativePartners" | "BinaryParameters" | "StringParameters" | "UserCredentialParameters")[];
/** User which initiates the call */
user?: string;
}, params?: RequestParams) => Promise<HttpResponse<any, OdataError>>;
};
stringParameters: {
/**
* @description You can use the following request to get all string parameters.
*
* @tags String Parameters
* @name StringParametersList
* @summary Get all string parameters.
* @request GET:/StringParameters
* @secure
*/
stringParametersList: (query?: {
/** User which initiates the call */
user?: string;
/**
* Show only the first n items.
* @min 0
*/
$top?: number;
/**
* Skip the first n items.
* @min 0
*/
$skip?: number;
/** Filter items by property values. */
$filter?: string;
/**
* Order items by property values.
* @uniqueItems true
*/
$orderby?: ("Value" | "Value desc")[];
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: "Value"[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiStringParameter[];
};
}, OdataError>>;
/**
* @description You can use the following request to add new string parameter.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags String Parameters
* @name StringParametersCreate
* @summary Add new string parameter.
* @request POST:/StringParameters
* @secure
*/
stringParametersCreate: (StringParameter: ComSapHciApiStringParameterCreate, query?: {
/** User which initiates the call */
user?: string;
}, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiStringParameter, void | OdataError>>;
};
stringParametersPidPidIdId: {
/**
* @description You can use the following request to get a string parameter by key.
*
* @tags String Parameters
* @name StringParametersPidIdList
* @summary Get string parameter by key.
* @request GET:/StringParameters(Pid='{Pid}',Id='{Id}')
* @secure
*/
stringParametersPidIdList: (pid: string, id: string, query?: {
/** User which initiates the call */
user?: string;
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: "Value"[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiStringParameter;
}, OdataError>>;
/**
* @description You can use the following request to update string parameter.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags String Parameters
* @name StringParametersPidIdUpdate
* @summary Update string parameter.
* @request PUT:/StringParameters(Pid='{Pid}',Id='{Id}')
* @secure
*/
stringParametersPidIdUpdate: (pid: string, id: string, StringParameter: ComSapHciApiStringParameterUpdate, query?: {
/** User which initiates the call */
user?: string;
}, params?: RequestParams) => Promise<HttpResponse<any, OdataError>>;
/**
* @description You can use the following request to delete string parameter.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags String Parameters
* @name StringParametersPidIdDelete
* @summary Delete string parameter.
* @request DELETE:/StringParameters(Pid='{Pid}',Id='{Id}')
* @secure
*/
stringParametersPidIdDelete: (pid: string, id: string, query?: {
/** User which initiates the call */
user?: string;
}, params?: RequestParams) => Promise<HttpResponse<any, OdataError>>;
};
userCredentialParameters: {
/**
* @description You can use the following request to get all user credential parameters.
*
* @tags User Credential Parameters
* @name UserCredentialParametersList
* @summary Get all user credential parameters.
* @request GET:/UserCredentialParameters
* @secure
*/
userCredentialParametersList: (query: {
/** User which initiates the call */
user?: string;
/**
* Filter is required for partner identifier (Pid) with equals operator (eq).<br>
* Example: ```Pid eq 'Receiver_1'```
* @default "Pid eq ''"
*/
$filter: string;
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("Id" | "Pid" | "User" | "CreatedBy" | "CreatedTime" | "LastModifiedBy" | "LastModifiedTime")[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiUserCredentialParameter[];
};
}, void | OdataError>>;
/**
* @description You can use the following request to add/update user credential parameter.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags User Credential Parameters
* @name UserCredentialParametersCreate
* @summary Add/update user credential parameter.
* @request POST:/UserCredentialParameters
* @secure
*/
userCredentialParametersCreate: (UserCredentialParameter: ComSapHciApiUserCredentialParameterCreate, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiUserCredentialParameter, void | OdataError>>;
};
userCredentialParametersPidPidIdId: {
/**
* @description You can use the following request to get user credential parameter by key.
*
* @tags User Credential Parameters
* @name UserCredentialParametersPidIdList
* @summary Get user credential parameter by key.
* @request GET:/UserCredentialParameters(Pid='{Pid}',Id='{Id}')
* @secure
*/
userCredentialParametersPidIdList: (pid: string, id: string, query?: {
/**
* Select required hash format, if password should be returned.
* @uniqueItems true
*/
returnHashedPassword?: "SHA256"[];
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("User" | "Password" | "CreatedBy" | "CreatedTime" | "LastModifiedBy" | "LastModifiedTime")[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiUserCredentialParameter;
}, OdataError>>;
/**
* @description You can use the following request to delete user credential parameter.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update the partner directory.
*
* @tags User Credential Parameters
* @name UserCredentialParametersPidIdDelete
* @summary Delete user credential parameter.
* @request DELETE:/UserCredentialParameters(Pid='{Pid}',Id='{Id}')
* @secure
*/
userCredentialParametersPidIdDelete: (pid: string, id: string, params?: RequestParams) => Promise<HttpResponse<any, OdataError>>;
};
}
export {};