@wix/auth-management 1.0.40 → 1.0.42

package/type-bundles/meta.bundle.d.ts

@@ -1,447 +0,0 @@
-/** An intermediary application that authorizes and authenticates an external client to access data on a Wix project or site. */
-interface OAuthApp$1 {
-    /**
-     * ID of the OAuth app.
-     * @readonly
-     */
-    id?: string | null;
-    /**
-     * Date and time the OAuth app was created, in ISO 8601 format.
-     * @readonly
-     */
-    createdDate?: Date | null;
-    /** Display name of the OAuth app, as it appears in the dashboard. */
-    name?: string | null;
-    /** Description of the OAuth app, as it appears in the dashboard. */
-    description?: string | null;
-    /**
-     * For internal use only.
-     * @readonly
-     * @deprecated
-     */
-    secret?: string | null;
-    /** External login URL to which users are redirected automatically to authenticate. If no login URL is specified, the user is redirected to Wix to authenticate. */
-    loginUrl?: string | null;
-    /**
-     * List of URIs to which redirection from Wix is allowed after authentication.
-     *
-     * When a client redirects a user to Wix for authentication, the client provides a URI to redirect the user back to after the user has been authenticated.
-     * Wix only redirects the user if the exact URI is contained in this array.
-     */
-    allowedRedirectUris?: string[];
-    /**
-     * List of domains to which redirection from Wix is allowed after processes other than authentication.
-     *
-     * When a client redirects a user to a Wix page (for example, for checkout), the client provides a URL to redirect the user back to.
-     * Wix only redirects the user if the URL is in one of the specified domains.
-     */
-    allowedRedirectDomains?: string[];
-    /**
-     * Whether a secret can be generated for this OAuth app.
-     *
-     * Default: `true` until a secret has been generated for the OAuth App.
-     */
-    allowSecretGeneration?: boolean | null;
-    /** External logout URL to which we invoke when user logout at wix. If no logout URL is specified, the user is logged out only at Wix. */
-    logoutUrl?: string | null;
-    /** OAuth application type. */
-    applicationType?: OAuthAppType$1;
-    /** OAuth technology used by the oauth application. */
-    technology?: OAuthTechnologies$1;
-}
-/** OAuth application type. */
-declare enum OAuthAppType$1 {
-    /** OAuth app type is not specified. */
-    OAUTH_APP_TYPE_UNSPECIFIED = "OAUTH_APP_TYPE_UNSPECIFIED",
-    /** OAuth app type is a web application. */
-    WEB_APP = "WEB_APP",
-    /** OAuth app type is a mobile application. */
-    MOBILE = "MOBILE",
-    /** OAuth app type is some other type of application. */
-    OTHER = "OTHER"
-}
-/** OAuth technology used by the oauth application. */
-declare enum OAuthTechnologies$1 {
-    /** The OAuth technology is not specified. */
-    OAUTH_TECHNOLOGY_UNSPECIFIED = "OAUTH_TECHNOLOGY_UNSPECIFIED",
-    /** OAuth technology using JavaScript. */
-    JAVASCRIPT = "JAVASCRIPT",
-    /** OAuth technology using Angular. */
-    ANGULAR = "ANGULAR",
-    /** OAuth technology using Vue.js. */
-    VUE = "VUE",
-    /** OAuth technology using React. */
-    REACT = "REACT",
-    /** OAuth technology using React Native. */
-    REACT_NATIVE = "REACT_NATIVE",
-    /** OAuth technology using iOS. */
-    IOS = "IOS",
-    /** OAuth technology using Android. */
-    ANDROID = "ANDROID",
-    /** OAuth technology using some other kind of technology. */
-    OTHER_TECHNOLOGY = "OTHER_TECHNOLOGY"
-}
-interface CreateOAuthAppRequest$1 {
-    /** OAuth app to create. */
-    oAuthApp: OAuthApp$1;
-}
-interface CreateOAuthAppResponse$1 {
-    /** Created OAuth app info. */
-    oAuthApp?: OAuthApp$1;
-}
-interface GetOAuthAppRequest$1 {
-    /** ID of the OAuth app to retrieve. */
-    oAuthAppId: string;
-}
-interface GetOAuthAppResponse$1 {
-    /** Retrieved OAuth app info. */
-    oAuthApp?: OAuthApp$1;
-}
-interface UpdateOAuthAppRequest$1 {
-    /** Updated OAuth app details. May include some or all fields. */
-    oAuthApp: OAuthApp$1;
-}
-interface UpdateOAuthAppResponse$1 {
-    /** Updated OAuth app info. */
-    oAuthApp?: OAuthApp$1;
-}
-interface QueryOAuthAppsRequest$1 {
-    /** Query options. */
-    query?: PlatformQuery$1;
-}
-interface PlatformQuery$1 extends PlatformQueryPagingMethodOneOf$1 {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging$1;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging$1;
-    /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object in the following format:
-     * `[{"fieldName":"name","order":"ASC"},{"fieldName":"created_date","order":"DESC"}]`
-     */
-    sort?: Sorting$1[];
-}
-/** @oneof */
-interface PlatformQueryPagingMethodOneOf$1 {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging$1;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging$1;
-}
-interface Sorting$1 {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder$1;
-}
-declare enum SortOrder$1 {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-interface Paging$1 {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-interface CursorPaging$1 {
-    /** Maximum number of items to return in the results. */
-    limit?: number | null;
-    /**
-     * Pointer to the next or previous page in the list of results.
-     *
-     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
-     * Not relevant for the first request.
-     */
-    cursor?: string | null;
-}
-interface QueryOAuthAppsResponse$1 {
-    /** List of OAuth apps matching the query. */
-    oAuthApps?: OAuthApp$1[];
-    /** Paging metadata. */
-    pagingMetadata?: PagingMetadataV2$1;
-}
-interface PagingMetadataV2$1 {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors$1;
-}
-interface Cursors$1 {
-    /** Cursor string pointing to the next page in the list of results. */
-    next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
-    prev?: string | null;
-}
-interface OAuthAppNonNullableFields$1 {
-    allowedDomains: string[];
-    allowedRedirectUris: string[];
-    allowedRedirectDomains: string[];
-    applicationType: OAuthAppType$1;
-    technology: OAuthTechnologies$1;
-}
-interface CreateOAuthAppResponseNonNullableFields$1 {
-    oAuthApp?: OAuthAppNonNullableFields$1;
-}
-interface GetOAuthAppResponseNonNullableFields$1 {
-    oAuthApp?: OAuthAppNonNullableFields$1;
-}
-interface UpdateOAuthAppResponseNonNullableFields$1 {
-    oAuthApp?: OAuthAppNonNullableFields$1;
-}
-interface QueryOAuthAppsResponseNonNullableFields$1 {
-    oAuthApps: OAuthAppNonNullableFields$1[];
-}
-
-/** An intermediary application that authorizes and authenticates an external client to access data on a Wix project or site. */
-interface OAuthApp {
-    /**
-     * ID of the OAuth app.
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Date and time the OAuth app was created, in ISO 8601 format.
-     * @readonly
-     */
-    _createdDate?: Date | null;
-    /** Display name of the OAuth app, as it appears in the dashboard. */
-    name?: string | null;
-    /** Description of the OAuth app, as it appears in the dashboard. */
-    description?: string | null;
-    /**
-     * For internal use only.
-     * @readonly
-     * @deprecated
-     */
-    secret?: string | null;
-    /** External login URL to which users are redirected automatically to authenticate. If no login URL is specified, the user is redirected to Wix to authenticate. */
-    loginUrl?: string | null;
-    /**
-     * List of URIs to which redirection from Wix is allowed after authentication.
-     *
-     * When a client redirects a user to Wix for authentication, the client provides a URI to redirect the user back to after the user has been authenticated.
-     * Wix only redirects the user if the exact URI is contained in this array.
-     */
-    allowedRedirectUris?: string[];
-    /**
-     * List of domains to which redirection from Wix is allowed after processes other than authentication.
-     *
-     * When a client redirects a user to a Wix page (for example, for checkout), the client provides a URL to redirect the user back to.
-     * Wix only redirects the user if the URL is in one of the specified domains.
-     */
-    allowedRedirectDomains?: string[];
-    /**
-     * Whether a secret can be generated for this OAuth app.
-     *
-     * Default: `true` until a secret has been generated for the OAuth App.
-     */
-    allowSecretGeneration?: boolean | null;
-    /** External logout URL to which we invoke when user logout at wix. If no logout URL is specified, the user is logged out only at Wix. */
-    logoutUrl?: string | null;
-    /** OAuth application type. */
-    applicationType?: OAuthAppType;
-    /** OAuth technology used by the oauth application. */
-    technology?: OAuthTechnologies;
-}
-/** OAuth application type. */
-declare enum OAuthAppType {
-    /** OAuth app type is not specified. */
-    OAUTH_APP_TYPE_UNSPECIFIED = "OAUTH_APP_TYPE_UNSPECIFIED",
-    /** OAuth app type is a web application. */
-    WEB_APP = "WEB_APP",
-    /** OAuth app type is a mobile application. */
-    MOBILE = "MOBILE",
-    /** OAuth app type is some other type of application. */
-    OTHER = "OTHER"
-}
-/** OAuth technology used by the oauth application. */
-declare enum OAuthTechnologies {
-    /** The OAuth technology is not specified. */
-    OAUTH_TECHNOLOGY_UNSPECIFIED = "OAUTH_TECHNOLOGY_UNSPECIFIED",
-    /** OAuth technology using JavaScript. */
-    JAVASCRIPT = "JAVASCRIPT",
-    /** OAuth technology using Angular. */
-    ANGULAR = "ANGULAR",
-    /** OAuth technology using Vue.js. */
-    VUE = "VUE",
-    /** OAuth technology using React. */
-    REACT = "REACT",
-    /** OAuth technology using React Native. */
-    REACT_NATIVE = "REACT_NATIVE",
-    /** OAuth technology using iOS. */
-    IOS = "IOS",
-    /** OAuth technology using Android. */
-    ANDROID = "ANDROID",
-    /** OAuth technology using some other kind of technology. */
-    OTHER_TECHNOLOGY = "OTHER_TECHNOLOGY"
-}
-interface CreateOAuthAppRequest {
-    /** OAuth app to create. */
-    oAuthApp: OAuthApp;
-}
-interface CreateOAuthAppResponse {
-    /** Created OAuth app info. */
-    oAuthApp?: OAuthApp;
-}
-interface GetOAuthAppRequest {
-    /** ID of the OAuth app to retrieve. */
-    oAuthAppId: string;
-}
-interface GetOAuthAppResponse {
-    /** Retrieved OAuth app info. */
-    oAuthApp?: OAuthApp;
-}
-interface UpdateOAuthAppRequest {
-    /** Updated OAuth app details. May include some or all fields. */
-    oAuthApp: OAuthApp;
-}
-interface UpdateOAuthAppResponse {
-    /** Updated OAuth app info. */
-    oAuthApp?: OAuthApp;
-}
-interface QueryOAuthAppsRequest {
-    /** Query options. */
-    query?: PlatformQuery;
-}
-interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-    /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object in the following format:
-     * `[{"fieldName":"name","order":"ASC"},{"fieldName":"created_date","order":"DESC"}]`
-     */
-    sort?: Sorting[];
-}
-/** @oneof */
-interface PlatformQueryPagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-}
-interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-interface CursorPaging {
-    /** Maximum number of items to return in the results. */
-    limit?: number | null;
-    /**
-     * Pointer to the next or previous page in the list of results.
-     *
-     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
-     * Not relevant for the first request.
-     */
-    cursor?: string | null;
-}
-interface QueryOAuthAppsResponse {
-    /** List of OAuth apps matching the query. */
-    oAuthApps?: OAuthApp[];
-    /** Paging metadata. */
-    pagingMetadata?: PagingMetadataV2;
-}
-interface PagingMetadataV2 {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
-}
-interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
-    next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
-    prev?: string | null;
-}
-interface OAuthAppNonNullableFields {
-    allowedDomains: string[];
-    allowedRedirectUris: string[];
-    allowedRedirectDomains: string[];
-    applicationType: OAuthAppType;
-    technology: OAuthTechnologies;
-}
-interface CreateOAuthAppResponseNonNullableFields {
-    oAuthApp?: OAuthAppNonNullableFields;
-}
-interface GetOAuthAppResponseNonNullableFields {
-    oAuthApp?: OAuthAppNonNullableFields;
-}
-interface UpdateOAuthAppResponseNonNullableFields {
-    oAuthApp?: OAuthAppNonNullableFields;
-}
-interface QueryOAuthAppsResponseNonNullableFields {
-    oAuthApps: OAuthAppNonNullableFields[];
-}
-
-type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
-    getUrl: (context: any) => string;
-    httpMethod: K;
-    path: string;
-    pathParams: M;
-    __requestType: T;
-    __originalRequestType: S;
-    __responseType: Q;
-    __originalResponseType: R;
-};
-declare function createOAuthApp(): __PublicMethodMetaInfo<'POST', {}, CreateOAuthAppRequest, CreateOAuthAppRequest$1, CreateOAuthAppResponse & CreateOAuthAppResponseNonNullableFields, CreateOAuthAppResponse$1 & CreateOAuthAppResponseNonNullableFields$1>;
-declare function getOAuthApp(): __PublicMethodMetaInfo<'GET', {
-    oAuthAppId: string;
-}, GetOAuthAppRequest, GetOAuthAppRequest$1, GetOAuthAppResponse & GetOAuthAppResponseNonNullableFields, GetOAuthAppResponse$1 & GetOAuthAppResponseNonNullableFields$1>;
-declare function updateOAuthApp(): __PublicMethodMetaInfo<'PATCH', {
-    oAuthAppId: string;
-}, UpdateOAuthAppRequest, UpdateOAuthAppRequest$1, UpdateOAuthAppResponse & UpdateOAuthAppResponseNonNullableFields, UpdateOAuthAppResponse$1 & UpdateOAuthAppResponseNonNullableFields$1>;
-declare function queryOAuthApps(): __PublicMethodMetaInfo<'POST', {}, QueryOAuthAppsRequest, QueryOAuthAppsRequest$1, QueryOAuthAppsResponse & QueryOAuthAppsResponseNonNullableFields, QueryOAuthAppsResponse$1 & QueryOAuthAppsResponseNonNullableFields$1>;
-
-type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
-declare const meta_createOAuthApp: typeof createOAuthApp;
-declare const meta_getOAuthApp: typeof getOAuthApp;
-declare const meta_queryOAuthApps: typeof queryOAuthApps;
-declare const meta_updateOAuthApp: typeof updateOAuthApp;
-declare namespace meta {
-  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createOAuthApp as createOAuthApp, meta_getOAuthApp as getOAuthApp, meta_queryOAuthApps as queryOAuthApps, meta_updateOAuthApp as updateOAuthApp };
-}
-
-export { meta as oAuthApps };