@wix/auth-management 1.0.0

package/build/es/src/headless-v1-o-auth-app.http.js

@@ -0,0 +1,160 @@
+import { toURLSearchParams } from '@wix/metro-runtime';
+import { serializer } from '@wix/metro-runtime/ambassador';
+import { resolveUrl } from '@wix/metro-runtime';
+const _createOAuthAppRequest = { oAuthApp: '_oAuthApp' };
+const _createOAuthAppResponse = { oAuthApp: '_oAuthApp' };
+const _getOAuthAppRequest = {};
+const _getOAuthAppResponse = { oAuthApp: '_oAuthApp' };
+const _oAuthApp = { createdDate: 'google.protobuf.Timestamp' };
+const _queryOAuthAppsRequest = {};
+const _queryOAuthAppsResponse = { oAuthApps: '_oAuthApp' };
+const _updateOAuthAppRequest = {
+    mask: 'google.protobuf.FieldMask',
+    oAuthApp: '_oAuthApp',
+};
+const _updateOAuthAppResponse = { oAuthApp: '_oAuthApp' };
+function resolveWixHeadlessV1OAuthAppServiceUrl(opts) {
+    const domainToMappings = {
+        'manage._base_domain_': [
+            {
+                srcPath: '/oauth-app-service',
+                destPath: '',
+            },
+            {
+                srcPath: '/oauth-app',
+                destPath: '',
+            },
+        ],
+        'www.wixapis.com': [
+            {
+                srcPath: '/oauth-app',
+                destPath: '',
+            },
+        ],
+    };
+    return resolveUrl(Object.assign(opts, { domainToMappings }));
+}
+/**
+ * Creates a new OAuth app for a Wix Headless client.
+ *
+ *
+ * An OAuth app authorizes an external client app or site, on any platform, to authenticate with a Wix site or project and manage its data.
+ *
+ * > **Note:** The OAuth app secret is returned only when creating the OAuth app, and can't be retrieved later. Store the secret in a secure location.
+ */
+export function createOAuthApp(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = serializer(_createOAuthAppRequest, { _oAuthApp });
+    const { fromJSON: fromRes } = serializer(_createOAuthAppResponse, {
+        _oAuthApp,
+    });
+    function __createOAuthApp({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            entityFqdn: 'wix.headless.v1.o_auth_app',
+            method: 'POST',
+            methodFqn: 'wix.headless.v1.OAuthAppService.CreateOAuthApp',
+            url: resolveWixHeadlessV1OAuthAppServiceUrl({
+                protoPath: '/v1/oauth-apps',
+                data: serializedData,
+                host,
+            }),
+            data: serializedData,
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __createOAuthApp.fromReq = fromReq;
+    return __createOAuthApp;
+}
+/** Retrieves an OAuth app by ID. */
+export function getOAuthApp(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = serializer(_getOAuthAppRequest, {});
+    const { fromJSON: fromRes } = serializer(_getOAuthAppResponse, { _oAuthApp });
+    function __getOAuthApp({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            entityFqdn: 'wix.headless.v1.o_auth_app',
+            method: 'GET',
+            methodFqn: 'wix.headless.v1.OAuthAppService.GetOAuthApp',
+            url: resolveWixHeadlessV1OAuthAppServiceUrl({
+                protoPath: '/v1/oauth-apps/{oAuthAppId}',
+                data: serializedData,
+                host,
+            }),
+            params: toURLSearchParams(serializedData),
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __getOAuthApp.fromReq = fromReq;
+    return __getOAuthApp;
+}
+/**
+ * Updates an OAuth app.
+ *
+ *
+ * Only fields provided in `mask` are updated.
+ *
+ * You can update the following fields:
+ * + `name`
+ * + `description`
+ * + `allowedDomain`
+ * + `loginUrl`
+ */
+export function updateOAuthApp(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = serializer(_updateOAuthAppRequest, { _oAuthApp });
+    const { fromJSON: fromRes } = serializer(_updateOAuthAppResponse, {
+        _oAuthApp,
+    });
+    function __updateOAuthApp({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            entityFqdn: 'wix.headless.v1.o_auth_app',
+            method: 'PATCH',
+            methodFqn: 'wix.headless.v1.OAuthAppService.UpdateOAuthApp',
+            url: resolveWixHeadlessV1OAuthAppServiceUrl({
+                protoPath: '/v1/oauth-apps/{oAuthApp.id}',
+                data: serializedData,
+                host,
+            }),
+            data: serializedData,
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __updateOAuthApp.fromReq = fromReq;
+    return __updateOAuthApp;
+}
+/**
+ * Retrieves a list of OAuth apps, given the provided paging, filtering, and sorting.
+ *
+ *
+ * Query OAuth Apps runs with these defaults, which you can override:
+ * + Results are sorted by `id` in descending order.
+ * + `paging.offset` is `0`.
+ */
+export function queryOAuthApps(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = serializer(_queryOAuthAppsRequest, {});
+    const { fromJSON: fromRes } = serializer(_queryOAuthAppsResponse, {
+        _oAuthApp,
+    });
+    function __queryOAuthApps({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            entityFqdn: 'wix.headless.v1.o_auth_app',
+            method: 'POST',
+            methodFqn: 'wix.headless.v1.OAuthAppService.QueryOAuthApps',
+            url: resolveWixHeadlessV1OAuthAppServiceUrl({
+                protoPath: '/v1/oauth-apps/query',
+                data: serializedData,
+                host,
+            }),
+            data: serializedData,
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __queryOAuthApps.fromReq = fromReq;
+    return __queryOAuthApps;
+}
+//# sourceMappingURL=headless-v1-o-auth-app.http.js.map

package/build/es/src/headless-v1-o-auth-app.http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"headless-v1-o-auth-app.http.js","sourceRoot":"","sources":["../../../src/headless-v1-o-auth-app.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAchD,MAAM,sBAAsB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACzD,MAAM,uBAAuB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AAC1D,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AACvD,MAAM,SAAS,GAAG,EAAE,WAAW,EAAE,2BAA2B,EAAE,CAAC;AAC/D,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC;AAC3D,MAAM,sBAAsB,GAAG;IAC7B,IAAI,EAAE,2BAA2B;IACjC,QAAQ,EAAE,WAAW;CACtB,CAAC;AACF,MAAM,uBAAuB,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC;AAE1D,SAAS,sCAAsC,CAC7C,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,EAAE;aACb;YACD;gBACE,OAAO,EAAE,YAAY;gBACrB,QAAQ,EAAE,EAAE;aACb;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,YAAY;gBACrB,QAAQ,EAAE,EAAE;aACb;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,OAA8B;IAE9B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,sBAAsB,EACtB,EAAE,SAAS,EAAE,CACd,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,uBAAuB,EAAE;QAChE,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,gBAAgB,CAAC,EAAE,IAAI,EAAO;QACrC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,gDAAgD;YAC3D,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,gBAAgB;gBAC3B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEnC,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,oCAAoC;AACpC,MAAM,UAAU,WAAW,CACzB,OAA2B;IAE3B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,mBAAmB,EACnB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,oBAAoB,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IAE9E,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,6CAA6C;YACxD,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,6BAA6B;gBACxC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,iBAAiB,CAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhC,OAAO,aAAa,CAAC;AACvB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,cAAc,CAC5B,OAA8B;IAE9B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,sBAAsB,EACtB,EAAE,SAAS,EAAE,CACd,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,uBAAuB,EAAE;QAChE,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,gBAAgB,CAAC,EAAE,IAAI,EAAO;QACrC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,OAAc;YACtB,SAAS,EAAE,gDAAgD;YAC3D,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,8BAA8B;gBACzC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEnC,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,OAA8B;IAE9B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,sBAAsB,EACtB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,uBAAuB,EAAE;QAChE,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,gBAAgB,CAAC,EAAE,IAAI,EAAO;QACrC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,gDAAgD;YAC3D,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,sBAAsB;gBACjC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEnC,OAAO,gBAAgB,CAAC;AAC1B,CAAC"}

package/build/es/src/headless-v1-o-auth-app.public.d.ts

@@ -0,0 +1,11 @@
+import { HttpClient } from '@wix/sdk-types';
+import { OAuthApp, UpdateOAuthApp } from './headless-v1-o-auth-app.universal';
+export declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+export declare function createOAuthApp(httpClient: HttpClient): (oAuthApp: OAuthApp) => Promise<OAuthApp>;
+export declare function getOAuthApp(httpClient: HttpClient): (oAuthAppId: string) => Promise<OAuthApp>;
+export declare function updateOAuthApp(httpClient: HttpClient): (_id: string | null, oAuthApp: UpdateOAuthApp, mask: string[]) => Promise<OAuthApp>;
+export declare function queryOAuthApps(httpClient: HttpClient): () => import("./headless-v1-o-auth-app.universal").OAuthAppsQueryBuilder;
+export { SortOrder } from './headless-v1-o-auth-app.universal';
+export { OAuthApp, CreateOAuthAppRequest, CreateOAuthAppResponse, GetOAuthAppRequest, GetOAuthAppResponse, UpdateOAuthAppRequest, UpdateOAuthAppResponse, DeleteOAuthAppRequest, DeleteOAuthAppResponse, QueryOAuthAppsRequest, PlatformQuery, PlatformQueryPagingMethodOneOf, Sorting, Paging, CursorPaging, QueryOAuthAppsResponse, PagingMetadataV2, Cursors, UpdateOAuthApp, OAuthAppsQueryResult, OAuthAppsQueryBuilder, } from './headless-v1-o-auth-app.universal';

package/build/es/src/headless-v1-o-auth-app.public.js

@@ -0,0 +1,24 @@
+import { createOAuthApp as universalCreateOAuthApp, getOAuthApp as universalGetOAuthApp, updateOAuthApp as universalUpdateOAuthApp, queryOAuthApps as universalQueryOAuthApps, } from './headless-v1-o-auth-app.universal';
+export const __metadata = { PACKAGE_NAME: '@wix/auth-management' };
+export function createOAuthApp(httpClient) {
+    return (oAuthApp) => universalCreateOAuthApp(oAuthApp, 
+    // @ts-ignore
+    { httpClient });
+}
+export function getOAuthApp(httpClient) {
+    return (oAuthAppId) => universalGetOAuthApp(oAuthAppId, 
+    // @ts-ignore
+    { httpClient });
+}
+export function updateOAuthApp(httpClient) {
+    return (_id, oAuthApp, mask) => universalUpdateOAuthApp(_id, oAuthApp, mask, 
+    // @ts-ignore
+    { httpClient });
+}
+export function queryOAuthApps(httpClient) {
+    return () => universalQueryOAuthApps(
+    // @ts-ignore
+    { httpClient });
+}
+export { SortOrder } from './headless-v1-o-auth-app.universal';
+//# sourceMappingURL=headless-v1-o-auth-app.public.js.map

package/build/es/src/headless-v1-o-auth-app.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"headless-v1-o-auth-app.public.js","sourceRoot":"","sources":["../../../src/headless-v1-o-auth-app.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,cAAc,IAAI,uBAAuB,EACzC,WAAW,IAAI,oBAAoB,EACnC,cAAc,IAAI,uBAAuB,EACzC,cAAc,IAAI,uBAAuB,GAG1C,MAAM,oCAAoC,CAAC;AAE5C,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,sBAAsB,EAAE,CAAC;AAEnE,MAAM,UAAU,cAAc,CAAC,UAAsB;IACnD,OAAO,CAAC,QAAkB,EAAE,EAAE,CAC5B,uBAAuB,CACrB,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,UAAsB;IAChD,OAAO,CAAC,UAAkB,EAAE,EAAE,CAC5B,oBAAoB,CAClB,UAAU;IACV,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,UAAsB;IACnD,OAAO,CAAC,GAAkB,EAAE,QAAwB,EAAE,IAAc,EAAE,EAAE,CACtE,uBAAuB,CACrB,GAAG,EACH,QAAQ,EACR,IAAI;IACJ,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,UAAsB;IACnD,OAAO,GAAG,EAAE,CACV,uBAAuB;IACrB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC"}

package/build/es/src/headless-v1-o-auth-app.types.d.ts

@@ -0,0 +1,153 @@
+/** An intermediary application that authorizes and authenticates an external client to access data on a Wix project or site. */
+export 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;
+    /** 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;
+    /**
+     * Client secret for the OAuth app. **Note:** This is returned only when the OAuth app is created. It can't be retrieved later.
+     * @readonly
+     */
+    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[];
+}
+export interface CreateOAuthAppRequest {
+    /** OAuth app to create. */
+    oAuthApp: OAuthApp;
+}
+export interface CreateOAuthAppResponse {
+    /** Created OAuth app info. */
+    oAuthApp?: OAuthApp;
+}
+export interface GetOAuthAppRequest {
+    /** ID of the OAuth app to retrieve. */
+    oAuthAppId: string;
+}
+export interface GetOAuthAppResponse {
+    /** Retrieved OAuth app info. */
+    oAuthApp?: OAuthApp;
+}
+export interface UpdateOAuthAppRequest {
+    /** Updated OAuth app details. May include some or all fields. */
+    oAuthApp: OAuthApp;
+    /** Explicit list of fields to update. Only fields listed are updated. */
+    mask: string[];
+}
+export interface UpdateOAuthAppResponse {
+    /** Updated OAuth app info. */
+    oAuthApp?: OAuthApp;
+}
+export interface DeleteOAuthAppRequest {
+    /** ID of the OAuth app to delete. */
+    oAuthAppId?: string;
+}
+export interface DeleteOAuthAppResponse {
+}
+export interface QueryOAuthAppsRequest {
+    /** Query options. */
+    query?: PlatformQuery;
+}
+export 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 */
+export 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;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface QueryOAuthAppsResponse {
+    /** List of OAuth apps matching the query. */
+    oAuthApps?: OAuthApp[];
+    /** Paging metadata. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export 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;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}

package/build/es/src/headless-v1-o-auth-app.types.js

@@ -0,0 +1,6 @@
+export var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder || (SortOrder = {}));
+//# sourceMappingURL=headless-v1-o-auth-app.types.js.map

package/build/es/src/headless-v1-o-auth-app.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"headless-v1-o-auth-app.types.js","sourceRoot":"","sources":["../../../src/headless-v1-o-auth-app.types.ts"],"names":[],"mappings":"AAuHA,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB"}

package/build/es/src/headless-v1-o-auth-app.universal.d.ts

@@ -0,0 +1,293 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+/** An intermediary application that authorizes and authenticates an external client to access data on a Wix project or site. */
+export 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;
+    /** 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;
+    /**
+     * Client secret for the OAuth app. **Note:** This is returned only when the OAuth app is created. It can't be retrieved later.
+     * @readonly
+     */
+    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[];
+}
+export interface CreateOAuthAppRequest {
+    /** OAuth app to create. */
+    oAuthApp: OAuthApp;
+}
+export interface CreateOAuthAppResponse {
+    /** Created OAuth app info. */
+    oAuthApp?: OAuthApp;
+}
+export interface GetOAuthAppRequest {
+    /** ID of the OAuth app to retrieve. */
+    oAuthAppId: string;
+}
+export interface GetOAuthAppResponse {
+    /** Retrieved OAuth app info. */
+    oAuthApp?: OAuthApp;
+}
+export interface UpdateOAuthAppRequest {
+    /** Updated OAuth app details. May include some or all fields. */
+    oAuthApp: OAuthApp;
+    /** Explicit list of fields to update. Only fields listed are updated. */
+    mask: string[];
+}
+export interface UpdateOAuthAppResponse {
+    /** Updated OAuth app info. */
+    oAuthApp?: OAuthApp;
+}
+export interface DeleteOAuthAppRequest {
+    /** ID of the OAuth app to delete. */
+    oAuthAppId?: string;
+}
+export interface DeleteOAuthAppResponse {
+}
+export interface QueryOAuthAppsRequest {
+    /** Query options. */
+    query?: PlatformQuery;
+}
+export 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 */
+export 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;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface CursorPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface QueryOAuthAppsResponse {
+    /** List of OAuth apps matching the query. */
+    oAuthApps?: OAuthApp[];
+    /** Paging metadata. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export 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;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+/**
+ * Creates a new OAuth app for a Wix Headless client.
+ *
+ *
+ * An OAuth app authorizes an external client app or site, on any platform, to authenticate with a Wix site or project and manage its data.
+ *
+ * > **Note:** The OAuth app secret is returned only when creating the OAuth app, and can't be retrieved later. Store the secret in a secure location.
+ * @param oAuthApp - OAuth app to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField oAuthApp
+ * @requiredField oAuthApp.name
+ * @returns Created OAuth app info.
+ */
+export declare function createOAuthApp(oAuthApp: OAuthApp): Promise<OAuthApp>;
+/**
+ * Retrieves an OAuth app by ID.
+ * @param oAuthAppId - ID of the OAuth app to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField oAuthAppId
+ * @returns Retrieved OAuth app info.
+ */
+export declare function getOAuthApp(oAuthAppId: string): Promise<OAuthApp>;
+/**
+ * Updates an OAuth app.
+ *
+ *
+ * Only fields provided in `mask` are updated.
+ *
+ * You can update the following fields:
+ * + `name`
+ * + `description`
+ * + `allowedDomain`
+ * + `loginUrl`
+ * @param _id - ID of the OAuth app.
+ * @param mask - Explicit list of fields to update. Only fields listed are updated.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField mask
+ * @requiredField oAuthApp
+ * @returns Updated OAuth app info.
+ */
+export declare function updateOAuthApp(_id: string | null, oAuthApp: UpdateOAuthApp, mask: string[]): Promise<OAuthApp>;
+export interface UpdateOAuthApp {
+    /**
+     * ID of the OAuth app.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Date and time the OAuth app was created, in ISO 8601 format.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /** 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;
+    /**
+     * Client secret for the OAuth app. **Note:** This is returned only when the OAuth app is created. It can't be retrieved later.
+     * @readonly
+     */
+    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[];
+}
+/**
+ * Retrieves a list of OAuth apps, given the provided paging, filtering, and sorting.
+ *
+ *
+ * Query OAuth Apps runs with these defaults, which you can override:
+ * + Results are sorted by `id` in descending order.
+ * + `paging.offset` is `0`.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryOAuthApps(): OAuthAppsQueryBuilder;
+interface QueryOffsetResult {
+    currentPage: number;
+    totalPages: number;
+    totalCount: number;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface OAuthAppsQueryResult extends QueryOffsetResult {
+    items: OAuthApp[];
+    query: OAuthAppsQueryBuilder;
+    next: () => Promise<OAuthAppsQueryResult>;
+    prev: () => Promise<OAuthAppsQueryResult>;
+}
+export interface OAuthAppsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id', value: any) => OAuthAppsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_createdDate' | 'name'>) => OAuthAppsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_createdDate' | 'name'>) => OAuthAppsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => OAuthAppsQueryBuilder;
+    /** @param skip - Number of items to skip in the query results before returning the results.
+     * @documentationMaturity preview
+     */
+    skip: (skip: number) => OAuthAppsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<OAuthAppsQueryResult>;
+}
+export {};