@wix/auto_sdk_packages_packages 1.0.3 → 1.0.5

package/build/cjs/meta.d.ts

@@ -1 +1,543 @@
-export * from './src/premium-reseller-v1-packages-packages.meta.js';
+import { CreatePackageRequest as CreatePackageRequest$1, CreatePackageResponse as CreatePackageResponse$1, CancelPackageRequest as CancelPackageRequest$1, CancelPackageResponse as CancelPackageResponse$1, GetPackageRequest as GetPackageRequest$1, GetPackageResponse as GetPackageResponse$1, QueryPackagesRequest as QueryPackagesRequest$1, QueryPackagesResponse as QueryPackagesResponse$1, AssignProductInstanceToSiteRequest as AssignProductInstanceToSiteRequest$1, AssignProductInstanceToSiteResponse as AssignProductInstanceToSiteResponse$1, UnassignProductInstanceFromSiteRequest as UnassignProductInstanceFromSiteRequest$1, UnassignProductInstanceFromSiteResponse as UnassignProductInstanceFromSiteResponse$1, CancelProductInstanceRequest as CancelProductInstanceRequest$1, CancelProductInstanceResponse as CancelProductInstanceResponse$1, AdjustProductInstanceSpecificationsRequest as AdjustProductInstanceSpecificationsRequest$1, AdjustProductInstanceSpecificationsResponse as AdjustProductInstanceSpecificationsResponse$1, UpdatePackageExternalIdRequest as UpdatePackageExternalIdRequest$1, UpdatePackageExternalIdResponse as UpdatePackageExternalIdResponse$1 } from './index.typings.js';
+import '@wix/sdk-types';
+
+/**
+ * A package is group of instances of Wix services that a reseller offers to a
+ * customer as part of a single transaction.
+ */
+interface Package {
+    /**
+     * Package ID.
+     * @readonly
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * Wix account ID. See
+     * [Account Level APIs](https://dev.wix.com/docs/rest/account-level/about-account-level-apis)
+     * for more details.
+     * @readonly
+     * @format GUID
+     */
+    accountId?: string;
+    /**
+     * External reference. For example, an external subscription ID.
+     * This field isn't validated by Wix.
+     *
+     * Max: 100 characters
+     * @maxLength 100
+     */
+    externalId?: string | null;
+    /**
+     * Product instances that are included in the package.
+     *
+     * Min: 1 product instance
+     * Max: 1000 product instances
+     * @maxSize 1000
+     * @minSize 1
+     */
+    productInstances?: ProductInstance[];
+    /**
+     * Date and time the package was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the package was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+}
+/**
+ * A product instance is a specific instance of a Wix service that a reseller
+ * offers to one of their customers.
+ */
+interface ProductInstance extends ProductInstanceContractDetailsOneOf {
+    /** Billing information for the contract between the reseller and Wix. */
+    billingInfo?: ProductInstanceCycle;
+    /**
+     * ID of the instance of the resold Wix service. **Note:** Differs from the
+     * `catalogProductId`. Allows you to identify different instances of the same
+     * product in a package.
+     * @readonly
+     * @format GUID
+     */
+    instanceId?: string;
+    /**
+     * ID of the Wix site that the product instance is assigned to.
+     * See the [Query Sites API](https://dev.wix.com/api/rest/account-level-apis/sites/query-sites)
+     * for more information.
+     * @format GUID
+     */
+    siteId?: string | null;
+    /**
+     * Product ID, as defined in the Wix Premium Product Catalog.
+     * Contact the [Wix B2B sales team](mailto:bizdev@wix.com)
+     * for more details about available Wix services.
+     * @format GUID
+     */
+    catalogProductId?: string;
+    /**
+     * Status of the product instance.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /**
+     * Failure object. Only present for status `FAILED`. Describes why the product instance `FAILED`.
+     * @readonly
+     */
+    failure?: FailureReason;
+    /**
+     * Date and time the product instance was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the product instance was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Two-letter country code in
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+     * format. Specifies where customers can claim vouchers that may come with the
+     * product. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) to get more
+     * information about vouchers and supported locations.
+     * @format COUNTRY
+     */
+    countryCode?: string | null;
+    /**
+     * Date and time the product instance expires in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * Used only for instances that don't auto renew at the end of the current billing cycle.
+     * @readonly
+     */
+    expirationDate?: Date | null;
+    /**
+     * Discount code indicating that the reseller provisioned the product instance
+     * during a sale. Wix doesn't guarantee that a discount code reduces the
+     * price between Wix and the reseller, even when it's valid. Contact the
+     * [Wix B2B sales team](mailto:bizdev@wix.com) for more information.
+     *
+     * Max: 25 characters
+     * @maxLength 25
+     */
+    discountCode?: string | null;
+    /**
+     * ID of a different product instance that you can use to offer your customers
+     * time-limited free access to an additional product or service. For example,
+     * Wix offers a 1-year free domain registration to all customers who purchase a
+     * Premium plan. The referenced product instance must have either status `"PENDING"` or
+     * `"ACTIVE"`. You can use each product instance only a single time as reference
+     * instance.
+     * @format GUID
+     */
+    referenceProductInstanceId?: string | null;
+}
+/** @oneof */
+interface ProductInstanceContractDetailsOneOf {
+    /** Billing information for the contract between the reseller and Wix. */
+    billingInfo?: ProductInstanceCycle;
+}
+declare enum FailureReasonFailureReason {
+    UNKNOWN = "UNKNOWN",
+    /** The product instance couldn't be created because the Resellers API timed out. */
+    DELIVERY_TIMEOUT = "DELIVERY_TIMEOUT",
+    /** The product instance couldn't be created because an external process failed. */
+    EXTERNAL_FAILURE = "EXTERNAL_FAILURE"
+}
+/** @enumType */
+type FailureReasonFailureReasonWithLiterals = FailureReasonFailureReason | 'UNKNOWN' | 'DELIVERY_TIMEOUT' | 'EXTERNAL_FAILURE';
+declare enum IntervalIntervalUnit {
+    /** unknown interval unit */
+    UNKNOWN = "UNKNOWN",
+    /** Day */
+    DAY = "DAY",
+    /** Week */
+    WEEK = "WEEK",
+    /** Month */
+    MONTH = "MONTH",
+    /** Year */
+    YEAR = "YEAR"
+}
+/** @enumType */
+type IntervalIntervalUnitWithLiterals = IntervalIntervalUnit | 'UNKNOWN' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
+declare enum CycleDescriptorType {
+    /** The payment type hasn't been set. */
+    UNKNOWN = "UNKNOWN",
+    /** The reseller pays Wix in a single payment. */
+    ONE_TIME = "ONE_TIME",
+    /** The reseller pays Wix on a recurring schedule. */
+    RECURRING = "RECURRING"
+}
+/** @enumType */
+type CycleDescriptorTypeWithLiterals = CycleDescriptorType | 'UNKNOWN' | 'ONE_TIME' | 'RECURRING';
+interface CycleInterval {
+    /** Unit of the billing cycle. */
+    unit?: IntervalIntervalUnitWithLiterals;
+    /**
+     * Count of units that make up the billing cycle.
+     * @min 1
+     */
+    count?: number;
+}
+declare enum Status {
+    /** The product instance isn't yet available to the customer. */
+    PENDING = "PENDING",
+    /** The customer can use the product instance. */
+    ENABLED = "ENABLED",
+    /** The product instance isn't any longer available to the customer. */
+    CANCELED = "CANCELED",
+    /** The product instance couldn't be delivered successfully and has never been available to the customer. */
+    FAILED = "FAILED",
+    /** The product instance isn't yet available to the customer, because an external provider or the customer must take an action. */
+    AWAITING_ACTION = "AWAITING_ACTION"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'PENDING' | 'ENABLED' | 'CANCELED' | 'FAILED' | 'AWAITING_ACTION';
+interface FailureReason {
+    /** Failure code. */
+    code?: FailureReasonFailureReasonWithLiterals;
+    /** Failure message. */
+    message?: string;
+}
+interface ProductInstanceCycle {
+    /** Payment type. */
+    type?: CycleDescriptorTypeWithLiterals;
+    /** Duration of the billing cycle. Available only for `RECURRING` payments. */
+    cycleDuration?: CycleInterval;
+}
+interface CreatePackageRequest {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /**
+     * External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix.
+     * @maxLength 100
+     */
+    externalId?: string | null;
+    /**
+     * Wix services that are resold.
+     * @maxSize 1000
+     * @minSize 1
+     */
+    products: ProductInstance[];
+}
+interface CreatePackageResponse {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /** Created package. */
+    package?: Package;
+}
+interface CancelPackageRequest {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /**
+     * ID of the package to cancel.
+     * @format GUID
+     */
+    id: string;
+}
+interface CancelPackageResponse {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /** Canceled package. */
+    package?: Package;
+}
+interface GetPackageRequest {
+    /**
+     * Package ID.
+     * @format GUID
+     */
+    id: string;
+}
+interface GetPackageResponse {
+    /** Retrieved package. */
+    package?: Package;
+}
+interface QueryPackagesRequest {
+    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
+    query: QueryV2;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset 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.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     */
+    sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+/** @oneof */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset 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.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | '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.
+     * @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 QueryPackagesResponse {
+    /** Paging metadata. */
+    metadata?: PagingMetadataV2;
+    /**
+     * Retrieved packages.
+     *
+     * Max: 1000 packages
+     * @maxSize 1000
+     */
+    packages?: Package[];
+}
+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.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface AssignProductInstanceToSiteRequest {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /**
+     * ID of the product instance to assign to a site.
+     * @format GUID
+     */
+    instanceId: string;
+    /**
+     * ID of the site to which the product instance is assigned.
+     * @format GUID
+     */
+    siteId: string;
+}
+interface AssignProductInstanceToSiteResponse {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the assigned product instance. */
+    package?: Package;
+}
+interface UnassignProductInstanceFromSiteRequest {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /**
+     * ID of the product instance to unassign from a site.
+     * @format GUID
+     */
+    instanceId: string;
+}
+interface UnassignProductInstanceFromSiteResponse {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the unassigned product instance. */
+    package?: Package;
+}
+interface CancelProductInstanceRequest {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /**
+     * ID of the product instance to cancel.
+     * @format GUID
+     */
+    instanceId: string;
+}
+interface CancelProductInstanceResponse {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the previously included the canceled product instance. */
+    package?: Package;
+}
+interface AdjustProductInstanceSpecificationsRequest {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /**
+     * ID of the product instance to adjust.
+     * @format GUID
+     */
+    instanceId: string;
+    /**
+     * ID of the product to replace the original instance. Required in case you don't
+     * provide a new `billingInfo` object.
+     * @format GUID
+     */
+    catalogProductId?: string | null;
+    /**
+     * Information about the billing cycle. Required in case you don't provide a new
+     * `catalogProductId`. The new billing cycle must be supported for the service.
+     * Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
+     * information about a service's supported billing cycles. If
+     * you adjust the billing cycle for a product instance with `RECURRING`
+     * payments, you must also provide `billingInfo.cycleDuration.unit`.
+     */
+    billingInfo?: ProductInstanceCycle;
+    /**
+     * Discount code indicating that the reseller provisioned the product instance
+     * during a sale. In case you pass a code that isn't valid, the call succeeds and
+     * no discount is applied to the product instance. Wix doesn't guarantee that a
+     * discount code reduces the price between Wix and the reseller, even when it's
+     * valid. You can't add a discount code after you've created the
+     * product instance. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for
+     * more information about supported codes.
+     *
+     * Max: 25 characters
+     * @maxLength 25
+     */
+    discountCode?: string | null;
+}
+interface AdjustProductInstanceSpecificationsResponse {
+    /**
+     * Idempotency key.
+     * @maxLength 100
+     */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the adjusted product instance. */
+    package?: Package;
+}
+interface UpdatePackageExternalIdRequest {
+    /**
+     * ID of the package to update.
+     * @format GUID
+     */
+    packageId: string;
+    /**
+     * External ID that will be assigned to the package.
+     * @maxLength 100
+     */
+    externalId: string;
+}
+interface UpdatePackageExternalIdResponse {
+    /** Updated package. */
+    updatedPackage?: Package;
+}
+
+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 createPackage(): __PublicMethodMetaInfo<'POST', {}, CreatePackageRequest$1, CreatePackageRequest, CreatePackageResponse$1, CreatePackageResponse>;
+declare function createPackageV2(): __PublicMethodMetaInfo<'POST', {}, CreatePackageRequest$1, CreatePackageRequest, CreatePackageResponse$1, CreatePackageResponse>;
+declare function cancelPackage(): __PublicMethodMetaInfo<'DELETE', {
+    id: string;
+}, CancelPackageRequest$1, CancelPackageRequest, CancelPackageResponse$1, CancelPackageResponse>;
+declare function getPackage(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, GetPackageRequest$1, GetPackageRequest, GetPackageResponse$1, GetPackageResponse>;
+declare function queryPackages(): __PublicMethodMetaInfo<'POST', {}, QueryPackagesRequest$1, QueryPackagesRequest, QueryPackagesResponse$1, QueryPackagesResponse>;
+declare function assignProductInstanceToSite(): __PublicMethodMetaInfo<'PATCH', {
+    instanceId: string;
+    siteId: string;
+}, AssignProductInstanceToSiteRequest$1, AssignProductInstanceToSiteRequest, AssignProductInstanceToSiteResponse$1, AssignProductInstanceToSiteResponse>;
+declare function unassignProductInstanceFromSite(): __PublicMethodMetaInfo<'PATCH', {
+    instanceId: string;
+}, UnassignProductInstanceFromSiteRequest$1, UnassignProductInstanceFromSiteRequest, UnassignProductInstanceFromSiteResponse$1, UnassignProductInstanceFromSiteResponse>;
+declare function cancelProductInstance(): __PublicMethodMetaInfo<'DELETE', {
+    instanceId: string;
+}, CancelProductInstanceRequest$1, CancelProductInstanceRequest, CancelProductInstanceResponse$1, CancelProductInstanceResponse>;
+declare function adjustProductInstanceSpecifications(): __PublicMethodMetaInfo<'PATCH', {
+    instanceId: string;
+}, AdjustProductInstanceSpecificationsRequest$1, AdjustProductInstanceSpecificationsRequest, AdjustProductInstanceSpecificationsResponse$1, AdjustProductInstanceSpecificationsResponse>;
+declare function updatePackageExternalId(): __PublicMethodMetaInfo<'PATCH', {
+    packageId: string;
+    externalId: string;
+}, UpdatePackageExternalIdRequest$1, UpdatePackageExternalIdRequest, UpdatePackageExternalIdResponse$1, UpdatePackageExternalIdResponse>;
+
+export { type __PublicMethodMetaInfo, adjustProductInstanceSpecifications, assignProductInstanceToSite, cancelPackage, cancelProductInstance, createPackage, createPackageV2, getPackage, queryPackages, unassignProductInstanceFromSite, updatePackageExternalId };