@wix/auto_sdk_benefit-programs_program-definitions 1.0.13 → 1.0.15

package/build/meta.d.mts

@@ -1,245 +0,0 @@
-import { c as CreateProgramDefinitionRequest$1, d as CreateProgramDefinitionResponse$1, e as UpdateProgramDefinitionRequest$1, f as UpdateProgramDefinitionResponse$1, g as DeleteProgramDefinitionRequest$1, h as DeleteProgramDefinitionResponse$1, i as GetProgramDefinitionRequest$1, j as GetProgramDefinitionResponse$1, k as GetProgramDefinitionByExternalIdAndNamespaceRequest$1, a as GetProgramDefinitionByExternalIdAndNamespaceResponse$1, Q as QueryProgramDefinitionsRequest$1, p as QueryProgramDefinitionsResponse$1 } from './benefit-programs-v1-program-definition-program-definitions.universal-u-PVpH8k.mjs';
-
-interface ProgramDefinition {
-    /**
-     * Program definition ID.
-     * @format GUID
-     * @immutable
-     * @readonly
-     */
-    id?: string | null;
-    /**
-     * Revision number, which increments by 1 each time the program definition is updated.
-     * To prevent conflicting changes, the current revision must be passed when updating the program definition.
-     *
-     * Ignored when creating a program definition.
-     * @readonly
-     */
-    revision?: string | null;
-    /**
-     * Date and time the program definition was created.
-     * @readonly
-     */
-    createdDate?: Date | null;
-    /**
-     * Date and time the program definition was updated.
-     * @readonly
-     */
-    updatedDate?: Date | null;
-    /**
-     * Program definition name.
-     * @maxLength 64
-     */
-    displayName?: string | null;
-    /**
-     * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
-     * @immutable
-     * @readonly
-     * @minLength 1
-     * @maxLength 50
-     */
-    namespace?: string | null;
-    /**
-     * Custom field data for the program definition object.
-     *
-     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
-     */
-    extendedFields?: ExtendedFields;
-    /**
-     * ID for the program definition defined by you. You can use `externalId` to filter queries.
-     * @format GUID
-     * @immutable
-     * @readonly
-     */
-    externalId?: string | null;
-}
-interface ExtendedFields {
-    /**
-     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
-     * The value of each key is structured according to the schema defined when the extended fields were configured.
-     *
-     * You can only access fields for which you have the appropriate permissions.
-     *
-     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
-     */
-    namespaces?: Record<string, Record<string, any>>;
-}
-interface CreateProgramDefinitionRequest {
-    /** Program definition to create. */
-    programDefinition: ProgramDefinition;
-}
-interface CreateProgramDefinitionResponse {
-    /** Created program definition. */
-    programDefinition?: ProgramDefinition;
-}
-interface UpdateProgramDefinitionRequest {
-    /** Program definition to update. */
-    programDefinition: ProgramDefinition;
-}
-interface UpdateProgramDefinitionResponse {
-    /** Updated program definition. */
-    programDefinition?: ProgramDefinition;
-}
-interface DeleteProgramDefinitionRequest {
-    /**
-     * ID of the program definition to delete.
-     * @format GUID
-     */
-    programDefinitionId: string;
-    /** Determines when the changes to this program definition will be applied to associated programs and pools. */
-    cascadeType?: Cascade;
-}
-declare enum Cascade {
-    /** Unknown cascade. */
-    UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
-    /** Changes are applied to existing programs and pools when they are next renewed. */
-    NEXT_RENEWAL = "NEXT_RENEWAL",
-    /** Changes are applied to associated programs and pools immediately. */
-    IMMEDIATELY = "IMMEDIATELY",
-    /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
-    FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
-}
-interface DeleteProgramDefinitionResponse {
-}
-interface GetProgramDefinitionRequest {
-    /**
-     * ID of the program definition to retrieve.
-     * @format GUID
-     */
-    programDefinitionId: string;
-}
-interface GetProgramDefinitionResponse {
-    /** Retrieved program definition. */
-    programDefinition?: ProgramDefinition;
-}
-interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
-    /**
-     * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
-     * @minLength 1
-     * @maxLength 50
-     */
-    namespace: string;
-    /**
-     * Program definition external ID.
-     * @format GUID
-     */
-    externalId: string;
-}
-interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
-    /** Retrieved program definition. */
-    programDefinition?: ProgramDefinition;
-}
-interface QueryProgramDefinitionsRequest {
-    /** Filter, sort, and paging to apply to the query. */
-    query?: CursorQuery;
-}
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /** 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.
-     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
-     * for more information.
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * List of sort objects.
-     * @maxSize 5
-     */
-    sort?: Sorting[];
-}
-/** @oneof */
-interface CursorQueryPagingMethodOneOf {
-    /** 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 {
-    /**
-     * Field to sort by.
-     * @maxLength 512
-     */
-    fieldName?: string;
-    /**
-     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
-     *
-     * Default: `ASC`
-     */
-    order?: SortOrder;
-}
-declare enum SortOrder {
-    /** Ascending sort order. */
-    ASC = "ASC",
-    /** Descending sort order. */
-    DESC = "DESC"
-}
-interface CursorPaging {
-    /**
-     * Maximum number of items to return.
-     * @max 100
-     */
-    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.
-     * @maxLength 16000
-     */
-    cursor?: string | null;
-}
-interface QueryProgramDefinitionsResponse {
-    /** List of retrieved program definitions. */
-    programDefinitions?: ProgramDefinition[];
-    /** Metadata for the paginated results. */
-    metadata?: CursorPagingMetadata;
-}
-interface CursorPagingMetadata {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Cursor strings that point to the next page, previous page, or both. */
-    cursors?: Cursors;
-    /**
-     * Whether there are more pages to retrieve following the current page.
-     *
-     * + `true`: Another page of results can be retrieved.
-     * + `false`: This is the last page.
-     */
-    hasNext?: boolean | null;
-}
-interface Cursors {
-    /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
-     */
-    next?: string | null;
-    /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
-     */
-    prev?: string | null;
-}
-
-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 createProgramDefinition(): __PublicMethodMetaInfo<'POST', {}, CreateProgramDefinitionRequest$1, CreateProgramDefinitionRequest, CreateProgramDefinitionResponse$1, CreateProgramDefinitionResponse>;
-declare function updateProgramDefinition(): __PublicMethodMetaInfo<'PATCH', {
-    programDefinitionId: string;
-}, UpdateProgramDefinitionRequest$1, UpdateProgramDefinitionRequest, UpdateProgramDefinitionResponse$1, UpdateProgramDefinitionResponse>;
-declare function deleteProgramDefinition(): __PublicMethodMetaInfo<'DELETE', {
-    programDefinitionId: string;
-}, DeleteProgramDefinitionRequest$1, DeleteProgramDefinitionRequest, DeleteProgramDefinitionResponse$1, DeleteProgramDefinitionResponse>;
-declare function getProgramDefinition(): __PublicMethodMetaInfo<'GET', {
-    programDefinitionId: string;
-}, GetProgramDefinitionRequest$1, GetProgramDefinitionRequest, GetProgramDefinitionResponse$1, GetProgramDefinitionResponse>;
-declare function getProgramDefinitionByExternalIdAndNamespace(): __PublicMethodMetaInfo<'GET', {}, GetProgramDefinitionByExternalIdAndNamespaceRequest$1, GetProgramDefinitionByExternalIdAndNamespaceRequest, GetProgramDefinitionByExternalIdAndNamespaceResponse$1, GetProgramDefinitionByExternalIdAndNamespaceResponse>;
-declare function queryProgramDefinitions(): __PublicMethodMetaInfo<'POST', {}, QueryProgramDefinitionsRequest$1, QueryProgramDefinitionsRequest, QueryProgramDefinitionsResponse$1, QueryProgramDefinitionsResponse>;
-
-export { type __PublicMethodMetaInfo, createProgramDefinition, deleteProgramDefinition, getProgramDefinition, getProgramDefinitionByExternalIdAndNamespace, queryProgramDefinitions, updateProgramDefinition };

package/build/meta.d.ts

@@ -1,245 +0,0 @@
-import { c as CreateProgramDefinitionRequest$1, d as CreateProgramDefinitionResponse$1, e as UpdateProgramDefinitionRequest$1, f as UpdateProgramDefinitionResponse$1, g as DeleteProgramDefinitionRequest$1, h as DeleteProgramDefinitionResponse$1, i as GetProgramDefinitionRequest$1, j as GetProgramDefinitionResponse$1, k as GetProgramDefinitionByExternalIdAndNamespaceRequest$1, a as GetProgramDefinitionByExternalIdAndNamespaceResponse$1, Q as QueryProgramDefinitionsRequest$1, p as QueryProgramDefinitionsResponse$1 } from './benefit-programs-v1-program-definition-program-definitions.universal-u-PVpH8k.js';
-
-interface ProgramDefinition {
-    /**
-     * Program definition ID.
-     * @format GUID
-     * @immutable
-     * @readonly
-     */
-    id?: string | null;
-    /**
-     * Revision number, which increments by 1 each time the program definition is updated.
-     * To prevent conflicting changes, the current revision must be passed when updating the program definition.
-     *
-     * Ignored when creating a program definition.
-     * @readonly
-     */
-    revision?: string | null;
-    /**
-     * Date and time the program definition was created.
-     * @readonly
-     */
-    createdDate?: Date | null;
-    /**
-     * Date and time the program definition was updated.
-     * @readonly
-     */
-    updatedDate?: Date | null;
-    /**
-     * Program definition name.
-     * @maxLength 64
-     */
-    displayName?: string | null;
-    /**
-     * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
-     * @immutable
-     * @readonly
-     * @minLength 1
-     * @maxLength 50
-     */
-    namespace?: string | null;
-    /**
-     * Custom field data for the program definition object.
-     *
-     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
-     */
-    extendedFields?: ExtendedFields;
-    /**
-     * ID for the program definition defined by you. You can use `externalId` to filter queries.
-     * @format GUID
-     * @immutable
-     * @readonly
-     */
-    externalId?: string | null;
-}
-interface ExtendedFields {
-    /**
-     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
-     * The value of each key is structured according to the schema defined when the extended fields were configured.
-     *
-     * You can only access fields for which you have the appropriate permissions.
-     *
-     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
-     */
-    namespaces?: Record<string, Record<string, any>>;
-}
-interface CreateProgramDefinitionRequest {
-    /** Program definition to create. */
-    programDefinition: ProgramDefinition;
-}
-interface CreateProgramDefinitionResponse {
-    /** Created program definition. */
-    programDefinition?: ProgramDefinition;
-}
-interface UpdateProgramDefinitionRequest {
-    /** Program definition to update. */
-    programDefinition: ProgramDefinition;
-}
-interface UpdateProgramDefinitionResponse {
-    /** Updated program definition. */
-    programDefinition?: ProgramDefinition;
-}
-interface DeleteProgramDefinitionRequest {
-    /**
-     * ID of the program definition to delete.
-     * @format GUID
-     */
-    programDefinitionId: string;
-    /** Determines when the changes to this program definition will be applied to associated programs and pools. */
-    cascadeType?: Cascade;
-}
-declare enum Cascade {
-    /** Unknown cascade. */
-    UNKNOWN_CASCADE = "UNKNOWN_CASCADE",
-    /** Changes are applied to existing programs and pools when they are next renewed. */
-    NEXT_RENEWAL = "NEXT_RENEWAL",
-    /** Changes are applied to associated programs and pools immediately. */
-    IMMEDIATELY = "IMMEDIATELY",
-    /** Changes are not applied to existing associated programs and pools. They are only applied to future programs and pools. */
-    FUTURE_PROVISIONS = "FUTURE_PROVISIONS"
-}
-interface DeleteProgramDefinitionResponse {
-}
-interface GetProgramDefinitionRequest {
-    /**
-     * ID of the program definition to retrieve.
-     * @format GUID
-     */
-    programDefinitionId: string;
-}
-interface GetProgramDefinitionResponse {
-    /** Retrieved program definition. */
-    programDefinition?: ProgramDefinition;
-}
-interface GetProgramDefinitionByExternalIdAndNamespaceRequest {
-    /**
-     * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
-     * @minLength 1
-     * @maxLength 50
-     */
-    namespace: string;
-    /**
-     * Program definition external ID.
-     * @format GUID
-     */
-    externalId: string;
-}
-interface GetProgramDefinitionByExternalIdAndNamespaceResponse {
-    /** Retrieved program definition. */
-    programDefinition?: ProgramDefinition;
-}
-interface QueryProgramDefinitionsRequest {
-    /** Filter, sort, and paging to apply to the query. */
-    query?: CursorQuery;
-}
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /** 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.
-     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
-     * for more information.
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * List of sort objects.
-     * @maxSize 5
-     */
-    sort?: Sorting[];
-}
-/** @oneof */
-interface CursorQueryPagingMethodOneOf {
-    /** 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 {
-    /**
-     * Field to sort by.
-     * @maxLength 512
-     */
-    fieldName?: string;
-    /**
-     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
-     *
-     * Default: `ASC`
-     */
-    order?: SortOrder;
-}
-declare enum SortOrder {
-    /** Ascending sort order. */
-    ASC = "ASC",
-    /** Descending sort order. */
-    DESC = "DESC"
-}
-interface CursorPaging {
-    /**
-     * Maximum number of items to return.
-     * @max 100
-     */
-    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.
-     * @maxLength 16000
-     */
-    cursor?: string | null;
-}
-interface QueryProgramDefinitionsResponse {
-    /** List of retrieved program definitions. */
-    programDefinitions?: ProgramDefinition[];
-    /** Metadata for the paginated results. */
-    metadata?: CursorPagingMetadata;
-}
-interface CursorPagingMetadata {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Cursor strings that point to the next page, previous page, or both. */
-    cursors?: Cursors;
-    /**
-     * Whether there are more pages to retrieve following the current page.
-     *
-     * + `true`: Another page of results can be retrieved.
-     * + `false`: This is the last page.
-     */
-    hasNext?: boolean | null;
-}
-interface Cursors {
-    /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
-     */
-    next?: string | null;
-    /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
-     */
-    prev?: string | null;
-}
-
-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 createProgramDefinition(): __PublicMethodMetaInfo<'POST', {}, CreateProgramDefinitionRequest$1, CreateProgramDefinitionRequest, CreateProgramDefinitionResponse$1, CreateProgramDefinitionResponse>;
-declare function updateProgramDefinition(): __PublicMethodMetaInfo<'PATCH', {
-    programDefinitionId: string;
-}, UpdateProgramDefinitionRequest$1, UpdateProgramDefinitionRequest, UpdateProgramDefinitionResponse$1, UpdateProgramDefinitionResponse>;
-declare function deleteProgramDefinition(): __PublicMethodMetaInfo<'DELETE', {
-    programDefinitionId: string;
-}, DeleteProgramDefinitionRequest$1, DeleteProgramDefinitionRequest, DeleteProgramDefinitionResponse$1, DeleteProgramDefinitionResponse>;
-declare function getProgramDefinition(): __PublicMethodMetaInfo<'GET', {
-    programDefinitionId: string;
-}, GetProgramDefinitionRequest$1, GetProgramDefinitionRequest, GetProgramDefinitionResponse$1, GetProgramDefinitionResponse>;
-declare function getProgramDefinitionByExternalIdAndNamespace(): __PublicMethodMetaInfo<'GET', {}, GetProgramDefinitionByExternalIdAndNamespaceRequest$1, GetProgramDefinitionByExternalIdAndNamespaceRequest, GetProgramDefinitionByExternalIdAndNamespaceResponse$1, GetProgramDefinitionByExternalIdAndNamespaceResponse>;
-declare function queryProgramDefinitions(): __PublicMethodMetaInfo<'POST', {}, QueryProgramDefinitionsRequest$1, QueryProgramDefinitionsRequest, QueryProgramDefinitionsResponse$1, QueryProgramDefinitionsResponse>;
-
-export { type __PublicMethodMetaInfo, createProgramDefinition, deleteProgramDefinition, getProgramDefinition, getProgramDefinitionByExternalIdAndNamespace, queryProgramDefinitions, updateProgramDefinition };