@epcc-sdk/sdks-shopper 0.2.0 → 0.3.0

package/dist/client/sdk.gen.d.cts

@@ -575,8 +575,8 @@ declare const getReleaseById: <ThrowOnError extends boolean = false>(options: Op
  *
  * | Operator | Description | Supported Attributes | Example |
  * |:--- |:--- |:--- |:--- |
- * | `eq` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. | `id`,`catalog_id`,`account_ids`,`customer_ids`,`channels`,`tags`,`pricebook_ids` | `filter=eq(id,some-id)` |
- * | `in` | Checks if the values are included in the specified string. If they are, the condition is true. | `id`,`account_ids`,`customer_ids`,`channels`,`tags`,`pricebook_ids` | `filter=in(account_ids,some-id,another-id)` |
+ * | `eq` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. | `id`,`catalog_id`,`account_ids`,`customer_ids`,`channels`,`tags`,`pricebook_ids`,`search_profile_slug` | `filter=eq(id,some-id)` |
+ * | `in` | Checks if the values are included in the specified string. If they are, the condition is true. | `id`,`account_ids`,`customer_ids`,`channels`,`tags`,`pricebook_ids`,`search_profile_slug` | `filter=in(account_ids,some-id,another-id)` |
  *
  */
 declare const getRules: <ThrowOnError extends boolean = false>(options?: Options<GetRulesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RuleListData, ErrorResponse, ThrowOnError>;
@@ -2471,7 +2471,7 @@ declare const putV2SettingsCartStoreId: <ThrowOnError extends boolean = false>(o
  * | Operator | Attribute | Description |
  * | --- | --- | --- |
  * | `eq` | `external_ref`, `plans.external_ref`, `proration_policy_id` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |
- * | `in` | `plans.external_ref` | In. Checks if the values are included in the specified string. If they are, the condition is true. |
+ * | `in` | `external_ref`, `plans.external_ref`, `proration_policy_id` | In. Checks if the value is in the specified list. If it is, the condition is true. |
  *
  */
 declare const listOfferings: <ThrowOnError extends boolean = false>(options?: Options<ListOfferingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
@@ -2526,6 +2526,7 @@ declare const listOfferingPlanPricingOptions: <ThrowOnError extends boolean = fa
  * | Operator | Attribute | Description |
  * | --- | --- | --- |
  * | `eq` | `account_id`, `name`, `email`, `external_ref` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |
+ * | `in` | `account_id`, `name`, `email`, `external_ref` | In. Checks if the value is in the specified list. If it is, the condition is true. |
  *
  * ### Including Resources
  *
@@ -2584,6 +2585,8 @@ declare const listSubscriptionStates: <ThrowOnError extends boolean = false>(opt
  * - `resumed`
  * For more information, see [Managing the Subscription Lifecycle](/docs/api/subscriptions/subscriptions#managing-the-subscription-lifecycle).
  *
+ * Immediate cancellation (`cancel` with `cancel_immediately: true`) ends the subscription and updates entitlements in this request; it does **not** issue refunds or modify paid invoices. Use payments refund flows separately if needed.
+ *
  */
 declare const createSubscriptionState: <ThrowOnError extends boolean = false>(options: Options<CreateSubscriptionStateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, SubscriptionsErrorResponse, ThrowOnError>;
 /**
@@ -2635,6 +2638,7 @@ declare const getSubscriptionInvoice: <ThrowOnError extends boolean = false>(opt
  * | Operator |Attribute | Description |
  * | --- | --- | --- |
  * | `eq` | `subscriber_id`, `subscription_id`, `outstanding`, `tax_required` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |
+ * | `in` | `subscriber_id`, `subscription_id` | In. Checks if the value is in the specified list. If it is, the condition is true. |
  *
  */
 declare const listInvoices: <ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
@@ -2893,11 +2897,7 @@ declare const createOneTimePasswordTokenRequest: <ThrowOnError extends boolean =
 declare const updatePasswordProfileInfo: <ThrowOnError extends boolean = false>(options: Options<UpdatePasswordProfileInfoData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PasswordProfileInfoResponse, unknown, ThrowOnError>;
 /**
  * Get all Currencies
- * :::caution
- *
- * This endpoint is for Administrator use only. Do not use this endpoint on your customer-facing frontends.
- *
- * :::
+ * Fetch all currencies.
  *
  */
 declare const getAllCurrencies: <ThrowOnError extends boolean = false>(options?: Options<GetAllCurrenciesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
@@ -2905,15 +2905,11 @@ declare const getAllCurrencies: <ThrowOnError extends boolean = false>(options?:
 }, ResponseError, ThrowOnError>;
 /**
  * Get a Currency
- * :::caution
- *
- * This endpoint is for Administrator use only. Do not use this endpoint on your customer-facing frontends.
- *
- * :::
+ * Fetch a currency by its ID.
  *
  */
 declare const getACurrency: <ThrowOnError extends boolean = false>(options: Options<GetACurrencyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
-    data?: Array<ResponseCurrency>;
+    data?: ResponseCurrency;
 }, ResponseError, ThrowOnError>;
 /**
  * Get all Files
@@ -2927,11 +2923,24 @@ declare const getACurrency: <ThrowOnError extends boolean = false>(options: Opti
  *
  * | Attribute             | Type      | Operators           | Example |
  * |:----------------------|:----------|:--------------------------|:-------------|
+ * | `id`                  | `string`  | `in`                      | `in(id,file-id-1,file-id-2,file-id-3)` |
  * | `file_name`           | `string`  | `eq` / `like`             | `eq(file_name, my_image.jpg)` |
  * | `width`               | `integer` | `gt` / `ge` / `lt` / `le` | `gt(width,200)` |
  * | `height`              | `integer` | `gt` / `ge` / `lt` / `le` | `lt(height,500)` |
  * | `file_size`           | `integer` | `gt` / `ge` / `lt` / `le` | `le(file_size,20953)` |
  *
+ * #### Bulk File Retrieval
+ *
+ * To retrieve multiple files by their IDs in a single request, use the `in` operator with a comma-separated list of file IDs:
+ *
+ * ```
+ * GET /v2/files?filter=in(id,06b881bd-f152-4c36-8658-7132a8fab49c,ec73567b-04e8-4000-a11a-7e1407cc2f21)
+ * ```
+ *
+ * This is more efficient than making separate requests for each file and is recommended for bulk operations.
+ *
+ * **Note on invalid IDs**: If any IDs in the filter are missing, malformed, or do not exist in the store, they will be silently ignored. The response will only include files that were successfully found. For example, if you request 5 IDs but only 3 exist, the response will contain 3 files with `total: 3` in the metadata.
+ *
  */
 declare const getAllFiles: <ThrowOnError extends boolean = false>(options?: Options<GetAllFilesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
     data?: Array<File>;

package/dist/client/sdk.gen.d.ts

@@ -575,8 +575,8 @@ declare const getReleaseById: <ThrowOnError extends boolean = false>(options: Op
  *
  * | Operator | Description | Supported Attributes | Example |
  * |:--- |:--- |:--- |:--- |
- * | `eq` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. | `id`,`catalog_id`,`account_ids`,`customer_ids`,`channels`,`tags`,`pricebook_ids` | `filter=eq(id,some-id)` |
- * | `in` | Checks if the values are included in the specified string. If they are, the condition is true. | `id`,`account_ids`,`customer_ids`,`channels`,`tags`,`pricebook_ids` | `filter=in(account_ids,some-id,another-id)` |
+ * | `eq` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. | `id`,`catalog_id`,`account_ids`,`customer_ids`,`channels`,`tags`,`pricebook_ids`,`search_profile_slug` | `filter=eq(id,some-id)` |
+ * | `in` | Checks if the values are included in the specified string. If they are, the condition is true. | `id`,`account_ids`,`customer_ids`,`channels`,`tags`,`pricebook_ids`,`search_profile_slug` | `filter=in(account_ids,some-id,another-id)` |
  *
  */
 declare const getRules: <ThrowOnError extends boolean = false>(options?: Options<GetRulesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<RuleListData, ErrorResponse, ThrowOnError>;
@@ -2471,7 +2471,7 @@ declare const putV2SettingsCartStoreId: <ThrowOnError extends boolean = false>(o
  * | Operator | Attribute | Description |
  * | --- | --- | --- |
  * | `eq` | `external_ref`, `plans.external_ref`, `proration_policy_id` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |
- * | `in` | `plans.external_ref` | In. Checks if the values are included in the specified string. If they are, the condition is true. |
+ * | `in` | `external_ref`, `plans.external_ref`, `proration_policy_id` | In. Checks if the value is in the specified list. If it is, the condition is true. |
  *
  */
 declare const listOfferings: <ThrowOnError extends boolean = false>(options?: Options<ListOfferingsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
@@ -2526,6 +2526,7 @@ declare const listOfferingPlanPricingOptions: <ThrowOnError extends boolean = fa
  * | Operator | Attribute | Description |
  * | --- | --- | --- |
  * | `eq` | `account_id`, `name`, `email`, `external_ref` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |
+ * | `in` | `account_id`, `name`, `email`, `external_ref` | In. Checks if the value is in the specified list. If it is, the condition is true. |
  *
  * ### Including Resources
  *
@@ -2584,6 +2585,8 @@ declare const listSubscriptionStates: <ThrowOnError extends boolean = false>(opt
  * - `resumed`
  * For more information, see [Managing the Subscription Lifecycle](/docs/api/subscriptions/subscriptions#managing-the-subscription-lifecycle).
  *
+ * Immediate cancellation (`cancel` with `cancel_immediately: true`) ends the subscription and updates entitlements in this request; it does **not** issue refunds or modify paid invoices. Use payments refund flows separately if needed.
+ *
  */
 declare const createSubscriptionState: <ThrowOnError extends boolean = false>(options: Options<CreateSubscriptionStateData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<void, SubscriptionsErrorResponse, ThrowOnError>;
 /**
@@ -2635,6 +2638,7 @@ declare const getSubscriptionInvoice: <ThrowOnError extends boolean = false>(opt
  * | Operator |Attribute | Description |
  * | --- | --- | --- |
  * | `eq` | `subscriber_id`, `subscription_id`, `outstanding`, `tax_required` | Equals. Checks if the values of two operands are equal. If they are, the condition is true. |
+ * | `in` | `subscriber_id`, `subscription_id` | In. Checks if the value is in the specified list. If it is, the condition is true. |
  *
  */
 declare const listInvoices: <ThrowOnError extends boolean = false>(options?: Options<ListInvoicesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
@@ -2893,11 +2897,7 @@ declare const createOneTimePasswordTokenRequest: <ThrowOnError extends boolean =
 declare const updatePasswordProfileInfo: <ThrowOnError extends boolean = false>(options: Options<UpdatePasswordProfileInfoData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PasswordProfileInfoResponse, unknown, ThrowOnError>;
 /**
  * Get all Currencies
- * :::caution
- *
- * This endpoint is for Administrator use only. Do not use this endpoint on your customer-facing frontends.
- *
- * :::
+ * Fetch all currencies.
  *
  */
 declare const getAllCurrencies: <ThrowOnError extends boolean = false>(options?: Options<GetAllCurrenciesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
@@ -2905,15 +2905,11 @@ declare const getAllCurrencies: <ThrowOnError extends boolean = false>(options?:
 }, ResponseError, ThrowOnError>;
 /**
  * Get a Currency
- * :::caution
- *
- * This endpoint is for Administrator use only. Do not use this endpoint on your customer-facing frontends.
- *
- * :::
+ * Fetch a currency by its ID.
  *
  */
 declare const getACurrency: <ThrowOnError extends boolean = false>(options: Options<GetACurrencyData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ResponseData & {
-    data?: Array<ResponseCurrency>;
+    data?: ResponseCurrency;
 }, ResponseError, ThrowOnError>;
 /**
  * Get all Files
@@ -2927,11 +2923,24 @@ declare const getACurrency: <ThrowOnError extends boolean = false>(options: Opti
  *
  * | Attribute             | Type      | Operators           | Example |
  * |:----------------------|:----------|:--------------------------|:-------------|
+ * | `id`                  | `string`  | `in`                      | `in(id,file-id-1,file-id-2,file-id-3)` |
  * | `file_name`           | `string`  | `eq` / `like`             | `eq(file_name, my_image.jpg)` |
  * | `width`               | `integer` | `gt` / `ge` / `lt` / `le` | `gt(width,200)` |
  * | `height`              | `integer` | `gt` / `ge` / `lt` / `le` | `lt(height,500)` |
  * | `file_size`           | `integer` | `gt` / `ge` / `lt` / `le` | `le(file_size,20953)` |
  *
+ * #### Bulk File Retrieval
+ *
+ * To retrieve multiple files by their IDs in a single request, use the `in` operator with a comma-separated list of file IDs:
+ *
+ * ```
+ * GET /v2/files?filter=in(id,06b881bd-f152-4c36-8658-7132a8fab49c,ec73567b-04e8-4000-a11a-7e1407cc2f21)
+ * ```
+ *
+ * This is more efficient than making separate requests for each file and is recommended for bulk operations.
+ *
+ * **Note on invalid IDs**: If any IDs in the filter are missing, malformed, or do not exist in the store, they will be silently ignored. The response will only include files that were successfully found. For example, if you request 5 IDs but only 3 exist, the response will contain 3 files with `total: 3` in the metadata.
+ *
  */
 declare const getAllFiles: <ThrowOnError extends boolean = false>(options?: Options<GetAllFilesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<{
     data?: Array<File>;