@wix/packages 1.0.0

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

@@ -0,0 +1,622 @@
+/**
+ * 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
+     */
+    _id?: string;
+    /**
+     * Wix account ID. See
+     * [Account Level APIs](https://dev.wix.com/api/rest/account-level-apis/about-account-level-apis)
+     * for more details.
+     * @readonly
+     */
+    accountId?: string;
+    /**
+     * External reference. For example, an external subscription ID.
+     * This field isn't validated by Wix.
+     *
+     * Max: 100 characters
+     */
+    externalId?: string | null;
+    /**
+     * Product instances that are included in the package.
+     *
+     * Min: 1 product instance
+     * Max: 1000 product instances
+     */
+    productInstances?: ProductInstance[];
+    /**
+     * Date and time the package was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the package was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+/**
+ * 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
+     */
+    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.
+     */
+    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.
+     */
+    catalogProductId?: string;
+    /**
+     * Status of the product instance.
+     *
+     * + `PENDING`: The product instance isn't yet available to the customer.
+     * + `ENABLED`: The customer can use the product instance.
+     * + `CANCELED`: The product instance isn't any longer available to the customer.
+     * + `FAILED`: The product instance couldn't be delivered successfully and has never been available to the customer.
+     * + `AWAITING_ACTION`: The product instance isn't yet available to the customer, because an external provider or the customer must take an action.
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * 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;
+    /**
+     * Date and time the product instance was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * 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.
+     */
+    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;
+    /**
+     * 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
+     */
+    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.
+     */
+    referenceProductInstanceId?: string | null;
+}
+/** @oneof */
+interface ProductInstanceContractDetailsOneOf {
+    /** Billing information for the contract between the reseller and Wix. */
+    billingInfo?: ProductInstanceCycle;
+}
+declare enum FailureReasonFailureReason {
+    UNKNOWN = "UNKNOWN",
+    /** The delivery of the product took too long */
+    DELIVERY_TIMEOUT = "DELIVERY_TIMEOUT",
+    /** An external process failed */
+    EXTERNAL_FAILURE = "EXTERNAL_FAILURE"
+}
+declare enum IntervalIntervalUnit {
+    /** unknown interval unit */
+    UNKNOWN = "UNKNOWN",
+    /** day */
+    DAY = "DAY",
+    /** week */
+    WEEK = "WEEK",
+    /** month */
+    MONTH = "MONTH",
+    /** year */
+    YEAR = "YEAR"
+}
+declare enum CycleDescriptorType {
+    UNKNOWN = "UNKNOWN",
+    ONE_TIME = "ONE_TIME",
+    RECURRING = "RECURRING"
+}
+interface CycleInterval {
+    /** Unit of the billing cycle. */
+    unit?: IntervalIntervalUnit;
+    /** Count of units that make up the billing cycle. */
+    count?: number;
+}
+declare enum Status {
+    PENDING = "PENDING",
+    ENABLED = "ENABLED",
+    CANCELED = "CANCELED",
+    FAILED = "FAILED",
+    AWAITING_ACTION = "AWAITING_ACTION"
+}
+interface FailureReason {
+    /**
+     * Failure code.
+     *
+     * + `DELIVERY_TIMEOUT`: The product instance couldn't be created because the Resellers API timed out.
+     * + `EXTERNAL_FAILURE`: The product instance couldn't be created because an external process failed. Contact the [Wix B2B sales team](mailto:bizdev@wix.com) for more information.
+     */
+    code?: FailureReasonFailureReason;
+    /** Failure message. */
+    message?: string;
+}
+interface ProductInstanceCycle {
+    /**
+     * Payment type.
+     * + `UNKNOWN`: The payment type hasn't been set.
+     * + `ONE_TIME`: The reseller pays Wix in a single payment.
+     * + `RECURRING`: The reseller pays Wix on a recurring schedule.
+     */
+    type?: CycleDescriptorType;
+    /** Duration of the billing cycle. Available only for `RECURRING` payments. */
+    cycleDuration?: CycleInterval;
+}
+interface CreatePackageResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Created package. */
+    package?: Package;
+}
+interface CancelPackageResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Canceled package. */
+    package?: Package;
+}
+interface GetPackageResponse {
+    /** Retrieved package. */
+    package?: Package;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** 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`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    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 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 QueryPackagesResponse {
+    /** Paging metadata. */
+    metadata?: PagingMetadataV2;
+    /**
+     * Retrieved packages.
+     *
+     * Max: 1000 packages
+     */
+    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. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+interface AssignProductInstanceToSiteResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the assigned product instance. */
+    package?: Package;
+}
+interface UnassignProductInstanceFromSiteResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the unassigned product instance. */
+    package?: Package;
+}
+interface CancelProductInstanceResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the previously included the canceled product instance. */
+    package?: Package;
+}
+interface AdjustProductInstanceSpecificationsResponse {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** Updated package that includes the adjusted product instance. */
+    package?: Package;
+}
+interface CreatePackageResponseNonNullableFields {
+    package?: {
+        _id: string;
+        accountId: string;
+        productInstances: {
+            billingInfo?: {
+                type: CycleDescriptorType;
+                cycleDuration?: {
+                    unit: IntervalIntervalUnit;
+                    count: number;
+                };
+            };
+            instanceId: string;
+            catalogProductId: string;
+            status: Status;
+            failure?: {
+                code: FailureReasonFailureReason;
+                message: string;
+            };
+        }[];
+    };
+}
+interface CancelPackageResponseNonNullableFields {
+    package?: {
+        _id: string;
+        accountId: string;
+        productInstances: {
+            billingInfo?: {
+                type: CycleDescriptorType;
+                cycleDuration?: {
+                    unit: IntervalIntervalUnit;
+                    count: number;
+                };
+            };
+            instanceId: string;
+            catalogProductId: string;
+            status: Status;
+            failure?: {
+                code: FailureReasonFailureReason;
+                message: string;
+            };
+        }[];
+    };
+}
+interface GetPackageResponseNonNullableFields {
+    package?: {
+        _id: string;
+        accountId: string;
+        productInstances: {
+            billingInfo?: {
+                type: CycleDescriptorType;
+                cycleDuration?: {
+                    unit: IntervalIntervalUnit;
+                    count: number;
+                };
+            };
+            instanceId: string;
+            catalogProductId: string;
+            status: Status;
+            failure?: {
+                code: FailureReasonFailureReason;
+                message: string;
+            };
+        }[];
+    };
+}
+interface QueryPackagesResponseNonNullableFields {
+    packages: {
+        _id: string;
+        accountId: string;
+        productInstances: {
+            billingInfo?: {
+                type: CycleDescriptorType;
+                cycleDuration?: {
+                    unit: IntervalIntervalUnit;
+                    count: number;
+                };
+            };
+            instanceId: string;
+            catalogProductId: string;
+            status: Status;
+            failure?: {
+                code: FailureReasonFailureReason;
+                message: string;
+            };
+        }[];
+    }[];
+}
+interface AssignProductInstanceToSiteResponseNonNullableFields {
+    package?: {
+        _id: string;
+        accountId: string;
+        productInstances: {
+            billingInfo?: {
+                type: CycleDescriptorType;
+                cycleDuration?: {
+                    unit: IntervalIntervalUnit;
+                    count: number;
+                };
+            };
+            instanceId: string;
+            catalogProductId: string;
+            status: Status;
+            failure?: {
+                code: FailureReasonFailureReason;
+                message: string;
+            };
+        }[];
+    };
+}
+interface UnassignProductInstanceFromSiteResponseNonNullableFields {
+    package?: {
+        _id: string;
+        accountId: string;
+        productInstances: {
+            billingInfo?: {
+                type: CycleDescriptorType;
+                cycleDuration?: {
+                    unit: IntervalIntervalUnit;
+                    count: number;
+                };
+            };
+            instanceId: string;
+            catalogProductId: string;
+            status: Status;
+            failure?: {
+                code: FailureReasonFailureReason;
+                message: string;
+            };
+        }[];
+    };
+}
+interface CancelProductInstanceResponseNonNullableFields {
+    package?: {
+        _id: string;
+        accountId: string;
+        productInstances: {
+            billingInfo?: {
+                type: CycleDescriptorType;
+                cycleDuration?: {
+                    unit: IntervalIntervalUnit;
+                    count: number;
+                };
+            };
+            instanceId: string;
+            catalogProductId: string;
+            status: Status;
+            failure?: {
+                code: FailureReasonFailureReason;
+                message: string;
+            };
+        }[];
+    };
+}
+interface AdjustProductInstanceSpecificationsResponseNonNullableFields {
+    package?: {
+        _id: string;
+        accountId: string;
+        productInstances: {
+            billingInfo?: {
+                type: CycleDescriptorType;
+                cycleDuration?: {
+                    unit: IntervalIntervalUnit;
+                    count: number;
+                };
+            };
+            instanceId: string;
+            catalogProductId: string;
+            status: Status;
+            failure?: {
+                code: FailureReasonFailureReason;
+                message: string;
+            };
+        }[];
+    };
+}
+interface CreatePackageOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. */
+    externalId?: string | null;
+    /** Wix services that are resold. */
+    products: ProductInstance[];
+}
+interface CreatePackageV2Options {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /** External reference. For example, an external subscription ID. **Note:** This field is not validated by Wix. */
+    externalId?: string | null;
+    /** Wix services that are resold. */
+    products: ProductInstance[];
+}
+interface CancelPackageOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+}
+interface AssignProductInstanceToSiteIdentifiers {
+    /** ID of the product instance to assign to a site. */
+    instanceId: string;
+    /** ID of the site to which the product instance is assigned. */
+    siteId: string;
+}
+interface AssignProductInstanceToSiteOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+}
+interface UnassignProductInstanceFromSiteOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+}
+interface CancelProductInstanceOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+}
+interface AdjustProductInstanceSpecificationsOptions {
+    /** Idempotency key. */
+    idempotencyKey?: string | null;
+    /**
+     * ID of the product to replace the original instance. Required in case you don't
+     * provide a new `billingInfo` object.
+     */
+    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. Ignored when you don't pass a new `catalogProductId` as well.
+     * 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
+     */
+    discountCode?: string | null;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+
+declare function createPackage$1(httpClient: HttpClient): (options?: CreatePackageOptions) => Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
+declare function createPackageV2$1(httpClient: HttpClient): (options?: CreatePackageV2Options) => Promise<CreatePackageResponse & CreatePackageResponseNonNullableFields>;
+declare function cancelPackage$1(httpClient: HttpClient): (_id: string, options?: CancelPackageOptions) => Promise<CancelPackageResponse & CancelPackageResponseNonNullableFields>;
+declare function getPackage$1(httpClient: HttpClient): (_id: string) => Promise<GetPackageResponse & GetPackageResponseNonNullableFields>;
+declare function queryPackages$1(httpClient: HttpClient): (query: QueryV2) => Promise<QueryPackagesResponse & QueryPackagesResponseNonNullableFields>;
+declare function assignProductInstanceToSite$1(httpClient: HttpClient): (identifiers: AssignProductInstanceToSiteIdentifiers, options?: AssignProductInstanceToSiteOptions) => Promise<AssignProductInstanceToSiteResponse & AssignProductInstanceToSiteResponseNonNullableFields>;
+declare function unassignProductInstanceFromSite$1(httpClient: HttpClient): (instanceId: string, options?: UnassignProductInstanceFromSiteOptions) => Promise<UnassignProductInstanceFromSiteResponse & UnassignProductInstanceFromSiteResponseNonNullableFields>;
+declare function cancelProductInstance$1(httpClient: HttpClient): (instanceId: string, options?: CancelProductInstanceOptions) => Promise<CancelProductInstanceResponse & CancelProductInstanceResponseNonNullableFields>;
+declare function adjustProductInstanceSpecifications$1(httpClient: HttpClient): (instanceId: string, options?: AdjustProductInstanceSpecificationsOptions) => Promise<AdjustProductInstanceSpecificationsResponse & AdjustProductInstanceSpecificationsResponseNonNullableFields>;
+
+declare const createPackage: BuildRESTFunction<typeof createPackage$1>;
+declare const createPackageV2: BuildRESTFunction<typeof createPackageV2$1>;
+declare const cancelPackage: BuildRESTFunction<typeof cancelPackage$1>;
+declare const getPackage: BuildRESTFunction<typeof getPackage$1>;
+declare const queryPackages: BuildRESTFunction<typeof queryPackages$1>;
+declare const assignProductInstanceToSite: BuildRESTFunction<typeof assignProductInstanceToSite$1>;
+declare const unassignProductInstanceFromSite: BuildRESTFunction<typeof unassignProductInstanceFromSite$1>;
+declare const cancelProductInstance: BuildRESTFunction<typeof cancelProductInstance$1>;
+declare const adjustProductInstanceSpecifications: BuildRESTFunction<typeof adjustProductInstanceSpecifications$1>;
+
+declare const context_adjustProductInstanceSpecifications: typeof adjustProductInstanceSpecifications;
+declare const context_assignProductInstanceToSite: typeof assignProductInstanceToSite;
+declare const context_cancelPackage: typeof cancelPackage;
+declare const context_cancelProductInstance: typeof cancelProductInstance;
+declare const context_createPackage: typeof createPackage;
+declare const context_createPackageV2: typeof createPackageV2;
+declare const context_getPackage: typeof getPackage;
+declare const context_queryPackages: typeof queryPackages;
+declare const context_unassignProductInstanceFromSite: typeof unassignProductInstanceFromSite;
+declare namespace context {
+  export { context_adjustProductInstanceSpecifications as adjustProductInstanceSpecifications, context_assignProductInstanceToSite as assignProductInstanceToSite, context_cancelPackage as cancelPackage, context_cancelProductInstance as cancelProductInstance, context_createPackage as createPackage, context_createPackageV2 as createPackageV2, context_getPackage as getPackage, context_queryPackages as queryPackages, context_unassignProductInstanceFromSite as unassignProductInstanceFromSite };
+}
+
+export { context as packages };