diff --git a/basic_sdk_samples/global.d.ts b/basic_sdk_samples/global.d.ts deleted file mode 100644 index 70769db..0000000 --- a/basic_sdk_samples/global.d.ts +++ /dev/null @@ -1,1029 +0,0 @@ -declare interface ApiResponse { - raw: Response; - value(): Promise; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -declare const BASE_PATH: string; - -/** - * This is the base class for all generated API classes. - */ -declare class BaseAPI { - protected configuration: Configuration; - private static readonly jsonRegex; - private middleware; - constructor(configuration?: Configuration); - withMiddleware(this: T, ...middlewares: Middleware[]): T; - withPreMiddleware(this: T, ...preMiddlewares: Array): T; - withPostMiddleware(this: T, ...postMiddlewares: Array): T; - /** - * Check if the given MIME is a JSON MIME. - * JSON MIME examples: - * application/json - * application/json; charset=UTF8 - * APPLICATION/JSON - * application/vnd.company+json - * @param mime - MIME (Multipurpose Internet Mail Extensions) - * @return True if the given MIME is JSON, false otherwise. - */ - protected isJsonMime(mime: string | null | undefined): boolean; - protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise; - private createFetchParams; - private fetchApi; - /** - * Create a shallow clone of `this` by constructing a new instance - * and then shallow cloning data members. - */ - private clone; -} - -declare class BlobApiResponse { - raw: Response; - constructor(raw: Response); - value(): Promise; -} - -declare function canConsumeForm(consumes: Consume[]): boolean; - -declare const COLLECTION_FORMATS: { - csv: string; - ssv: string; - tsv: string; - pipes: string; -}; - -declare class Configuration { - private configuration; - constructor(configuration?: ConfigurationParameters); - set config(configuration: Configuration); - get basePath(): string; - get fetchApi(): FetchAPI | undefined; - get middleware(): Middleware[]; - get queryParamsStringify(): (params: HTTPQuery) => string; - get username(): string | undefined; - get password(): string | undefined; - get apiKey(): ((name: string) => string | Promise) | undefined; - get accessToken(): ((name?: string, scopes?: string[]) => string | Promise) | undefined; - get headers(): HTTPHeaders | undefined; - get credentials(): RequestCredentials | undefined; -} - -declare interface ConfigurationParameters { - basePath?: string; - fetchApi?: FetchAPI; - middleware?: Middleware[]; - queryParamsStringify?: (params: HTTPQuery) => string; - username?: string; - password?: string; - apiKey?: string | Promise | ((name: string) => string | Promise); - accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string | Promise); - headers?: HTTPHeaders; - credentials?: RequestCredentials; -} - -declare interface Consume { - contentType: string; -} - -declare const DefaultConfig: Configuration; - -declare interface ErrorContext { - fetch: FetchAPI; - url: string; - init: RequestInit; - error: unknown; - response?: Response; -} - -declare type FetchAPI = WindowOrWorkerGlobalScope['fetch']; - -declare class FetchError extends Error { - cause: Error; - name: "FetchError"; - constructor(cause: Error, msg?: string); -} - -declare interface FetchParams { - url: string; - init: RequestInit; -} - -/** - * @export - */ -declare const GetProductsUuidPaginationTypeEnum: { - readonly Page: "page"; - readonly SearchAfter: "search_after"; -}; - -declare type GetProductsUuidPaginationTypeEnum = typeof GetProductsUuidPaginationTypeEnum[keyof typeof GetProductsUuidPaginationTypeEnum]; - -declare interface GetProductsUuidRequest { - search?: string; - scope?: string; - locales?: string; - attributes?: string; - paginationType?: GetProductsUuidPaginationTypeEnum; - page?: number; - searchAfter?: string; - limit?: number; - withCount?: boolean; - withAttributeOptions?: boolean; - withAssetShareLinks?: boolean; - withQualityScores?: boolean; - withCompletenesses?: boolean; -} - -declare interface GetProductsUuidUuidRequest { - uuid: string; - withAttributeOptions?: boolean; - withAssetShareLinks?: boolean; - withQualityScores?: boolean; - withCompletenesses?: boolean; -} - -declare type HTTPBody = Json | FormData | URLSearchParams; - -declare type HTTPHeaders = { - [key: string]: string; -}; - -declare type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD'; - -declare type HTTPQuery = { - [key: string]: string | number | null | boolean | Array | Set | HTTPQuery; -}; - -declare type HTTPRequestInit = { - headers?: HTTPHeaders; - method: HTTPMethod; - credentials?: RequestCredentials; - body?: HTTPBody; -}; - -declare type InitOverrideFunction = (requestContext: { - init: HTTPRequestInit; - context: RequestOpts; -}) => Promise; - -declare type Json = any; - -declare class JSONApiResponse { - raw: Response; - private transformer; - constructor(raw: Response, transformer?: ResponseTransformer); - value(): Promise; -} - -declare function mapValues(data: any, fn: (item: any) => any): {}; - -declare interface Middleware { - pre?(context: RequestContext): Promise; - post?(context: ResponseContext): Promise; - onError?(context: ErrorContext): Promise; -} - -declare type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original'; - -export declare type PIM_CONTEXT = { - product: { - uuid: string; - identifier: string | null; - }; -}; - -export declare type PIM_SDK = { - user: PIM_USER; - context: PIM_CONTEXT; - api: { - products_uuid: ProductsUuidApi; - }; -}; - -export declare type PIM_USER = { - username: string; - first_name: string; - last_name: string; -}; - -/** - * - * @export - * @interface PostProductsUuidRequest - */ -declare interface PostProductsUuidRequest { - /** - * Product uuid - * @type {string} - * @memberof PostProductsUuidRequest - */ - uuid?: string; - /** - * Whether the product is enabled - * @type {boolean} - * @memberof PostProductsUuidRequest - */ - enabled?: boolean; - /** - * Family code from which the product inherits its attributes and attributes requirements. - * @type {string} - * @memberof PostProductsUuidRequest - */ - family?: string; - /** - * Codes of the categories in which the product is classified - * @type {Array} - * @memberof PostProductsUuidRequest - */ - categories?: Array; - /** - * Codes of the groups to which the product belong - * @type {Array} - * @memberof PostProductsUuidRequest - */ - groups?: Array; - /** - * Code of the parent product model when the product is a variant (only available since the 2.0). This parent can be modified since the 2.3. - * @type {string} - * @memberof PostProductsUuidRequest - */ - parent?: string; - /** - * Product attributes values, see Product values section for more details - * @type {{ [key: string]: Array; }} - * @memberof PostProductsUuidRequest - */ - values?: { - [key: string]: Array; - }; - /** - * - * @type {ProductsAllOfEmbeddedItemsInnerAllOfAssociations} - * @memberof PostProductsUuidRequest - */ - associations?: ProductsAllOfEmbeddedItemsInnerAllOfAssociations; - /** - * - * @type {ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations} - * @memberof PostProductsUuidRequest - */ - quantifiedAssociations?: ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations; - /** - * Date of creation - * @type {string} - * @memberof PostProductsUuidRequest - */ - created?: string; - /** - * Date of the last update - * @type {string} - * @memberof PostProductsUuidRequest - */ - updated?: string; - /** - * - * @type {ProductsAllOfEmbeddedItemsInnerAllOfMetadata} - * @memberof PostProductsUuidRequest - */ - metadata?: ProductsAllOfEmbeddedItemsInnerAllOfMetadata; - /** - * Product quality scores for each channel/locale combination (only available since the 5.0 and when the "with_quality_scores" query parameter is set to "true") - * @type {object} - * @memberof PostProductsUuidRequest - */ - qualityScores?: object; - /** - * Product completenesses for each channel/locale combination (only available since the 7.0 version, and when the "with_completenesses" query parameter is set to "true") - * @type {Array} - * @memberof PostProductsUuidRequest - */ - completenesses?: Array; -} - -/** - * - * @export - * @interface Products - */ -declare interface Products { - /** - * - * @type {ProductsAllOfLinks} - * @memberof Products - */ - links?: ProductsAllOfLinks; - /** - * Current page number - * @type {number} - * @memberof Products - */ - currentPage?: number; - /** - * - * @type {ProductsAllOfEmbedded} - * @memberof Products - */ - embedded?: ProductsAllOfEmbedded; -} - -/** - * - * @export - * @interface ProductsAllOfEmbedded - */ -declare interface ProductsAllOfEmbedded { - /** - * - * @type {Array} - * @memberof ProductsAllOfEmbedded - */ - items?: Array; -} - -/** - * - * @export - * @interface ProductsAllOfEmbeddedItemsInner - */ -declare interface ProductsAllOfEmbeddedItemsInner { - /** - * - * @type {ProductsAllOfEmbeddedItemsInnerAllOfLinks} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - links?: ProductsAllOfEmbeddedItemsInnerAllOfLinks; - /** - * Product uuid - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - uuid?: string; - /** - * Whether the product is enabled - * @type {boolean} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - enabled?: boolean; - /** - * Family code from which the product inherits its attributes and attributes requirements. - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - family?: string; - /** - * Codes of the categories in which the product is classified - * @type {Array} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - categories?: Array; - /** - * Codes of the groups to which the product belong - * @type {Array} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - groups?: Array; - /** - * Code of the parent product model when the product is a variant (only available since the 2.0). This parent can be modified since the 2.3. - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - parent?: string; - /** - * Product attributes values, see Product values section for more details - * @type {{ [key: string]: Array; }} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - values?: { - [key: string]: Array; - }; - /** - * - * @type {ProductsAllOfEmbeddedItemsInnerAllOfAssociations} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - associations?: ProductsAllOfEmbeddedItemsInnerAllOfAssociations; - /** - * - * @type {ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - quantifiedAssociations?: ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations; - /** - * Date of creation - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - created?: string; - /** - * Date of the last update - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - updated?: string; - /** - * - * @type {ProductsAllOfEmbeddedItemsInnerAllOfMetadata} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - metadata?: ProductsAllOfEmbeddedItemsInnerAllOfMetadata; - /** - * Product quality scores for each channel/locale combination (only available since the 5.0 and when the "with_quality_scores" query parameter is set to "true") - * @type {object} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - qualityScores?: object; - /** - * Product completenesses for each channel/locale combination (only available since the 7.0 version, and when the "with_completenesses" query parameter is set to "true") - * @type {Array} - * @memberof ProductsAllOfEmbeddedItemsInner - */ - completenesses?: Array; -} - -/** - * Several associations related to groups, product models and/or other products, grouped by association types - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfAssociations - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfAssociations { - /** - * - * @type {ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfAssociations - */ - associationTypeCode?: ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -/** - * - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode { - /** - * Array of groups codes with which the product is in relation - * @type {Array} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode - */ - groups?: Array; - /** - * Array of product uuids with which the product is in relation - * @type {Array} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode - */ - products?: Array; - /** - * Array of product model codes with which the product is in relation (only available since the v2.1) - * @type {Array} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode - */ - productModels?: Array; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -/** - * - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfCompletenessesInner - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfCompletenessesInner { - /** - * - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfCompletenessesInner - */ - scope?: string; - /** - * - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfCompletenessesInner - */ - locale?: string; - /** - * - * @type {number} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfCompletenessesInner - */ - data?: number; -} - -/** - * - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfLinks - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfLinks { - /** - * - * @type {ProductsAllOfEmbeddedItemsInnerAllOfLinksSelf} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfLinks - */ - self?: ProductsAllOfEmbeddedItemsInnerAllOfLinksSelf; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -/** - * - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfLinksSelf - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfLinksSelf { - /** - * URI of the resource - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfLinksSelf - */ - href?: string; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -/** - * More information around the product (only available since the v2.0 in the Enterprise Edition) - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfMetadata - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfMetadata { - /** - * Status of the product regarding the user permissions - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfMetadata - */ - workflowStatus?: ProductsAllOfEmbeddedItemsInnerAllOfMetadataWorkflowStatusEnum; -} - -/** - * @export - */ -declare const ProductsAllOfEmbeddedItemsInnerAllOfMetadataWorkflowStatusEnum: { - readonly ReadOnly: "read_only"; - readonly DraftInProgress: "draft_in_progress"; - readonly ProposalWaitingForApproval: "proposal_waiting_for_approval"; - readonly WorkingCopy: "working_copy"; -}; - -declare type ProductsAllOfEmbeddedItemsInnerAllOfMetadataWorkflowStatusEnum = typeof ProductsAllOfEmbeddedItemsInnerAllOfMetadataWorkflowStatusEnum[keyof typeof ProductsAllOfEmbeddedItemsInnerAllOfMetadataWorkflowStatusEnum]; - -/** - * Several quantified associations related to products and/or product models, grouped by quantified association types (only available since the 5.0) - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations { - /** - * - * @type {ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations - */ - quantifiedAssociationTypeCode?: ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode; -} - -/** - * - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode { - /** - * Array of objects containing product uuids and quantities with which the product is in relation - * @type {Array} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode - */ - products?: Array; - /** - * Array of objects containing product model codes and quantities with which the product is in relation - * @type {Array} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode - */ - productModels?: Array; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -/** - * - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductModelsInner - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductModelsInner { - /** - * - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductModelsInner - */ - code?: string; - /** - * - * @type {number} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductModelsInner - */ - quantity?: number; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -/** - * - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductsInner - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductsInner { - /** - * - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductsInner - */ - uuid?: string; - /** - * - * @type {number} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductsInner - */ - quantity?: number; -} - -/** - * - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner { - /** - * Channel code of the product value - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner - */ - scope?: string; - /** - * Locale code of the product value - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner - */ - locale?: string; - /** - * Product value. See the `data` format section for more details. - * @type {object} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner - */ - data?: object; - /** - * - * @type {ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner - */ - linkedData?: ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData; - /** - * The type of the value's attribute. See type section for more details. - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner - */ - attributeType?: string; - /** - * Reference entity code when the attribute type is `akeneo_reference_entity` or `akeneo_reference_entity_collection` OR Asset family code when the attribute type is `pim_catalog_asset_collection` - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner - */ - referenceDataName?: string; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -/** - * Object containing additional data when a related query parameter is enabled. See the `linked_data` format section for more details. (only available since the 5.0) - * @export - * @interface ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData - */ -declare interface ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData { - /** - * - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData - */ - attribute?: string; - /** - * - * @type {string} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData - */ - code?: string; - /** - * - * @type {object} - * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData - */ - labels?: object; -} - -/** - * - * @export - * @interface ProductsAllOfLinks - */ -declare interface ProductsAllOfLinks { - /** - * - * @type {ProductsAllOfLinksSelf} - * @memberof ProductsAllOfLinks - */ - self?: ProductsAllOfLinksSelf; - /** - * - * @type {ProductsAllOfLinksFirst} - * @memberof ProductsAllOfLinks - */ - first?: ProductsAllOfLinksFirst; - /** - * - * @type {ProductsAllOfLinksPrevious} - * @memberof ProductsAllOfLinks - */ - previous?: ProductsAllOfLinksPrevious; - /** - * - * @type {ProductsAllOfLinksNext} - * @memberof ProductsAllOfLinks - */ - next?: ProductsAllOfLinksNext; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -/** - * - * @export - * @interface ProductsAllOfLinksFirst - */ -declare interface ProductsAllOfLinksFirst { - /** - * URI of the first page of resources - * @type {string} - * @memberof ProductsAllOfLinksFirst - */ - href?: string; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -/** - * - * @export - * @interface ProductsAllOfLinksNext - */ -declare interface ProductsAllOfLinksNext { - /** - * URI of the next page of resources - * @type {string} - * @memberof ProductsAllOfLinksNext - */ - href?: string; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -/** - * - * @export - * @interface ProductsAllOfLinksPrevious - */ -declare interface ProductsAllOfLinksPrevious { - /** - * URI of the previous page of resources - * @type {string} - * @memberof ProductsAllOfLinksPrevious - */ - href?: string; -} - -/** - * Akeneo PIM REST API - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 1.0.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ -/** - * - * @export - * @interface ProductsAllOfLinksSelf - */ -declare interface ProductsAllOfLinksSelf { - /** - * URI of the current page of resources - * @type {string} - * @memberof ProductsAllOfLinksSelf - */ - href?: string; -} - -export declare type ProductsUuidApi = { - get: (requestParameters: GetProductsUuidUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; - list: (requestParameters: GetProductsUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; -}; - -declare function querystring(params: HTTPQuery, prefix?: string): string; - -declare interface RequestContext { - fetch: FetchAPI; - url: string; - init: RequestInit; -} - -declare interface RequestOpts { - path: string; - method: HTTPMethod; - headers: HTTPHeaders; - query?: HTTPQuery; - body?: HTTPBody; -} - -declare class RequiredError extends Error { - field: string; - name: "RequiredError"; - constructor(field: string, msg?: string); -} - -declare interface ResponseContext { - fetch: FetchAPI; - url: string; - init: RequestInit; - response: Response; -} - -declare class ResponseError extends Error { - response: Response; - name: "ResponseError"; - constructor(response: Response, msg?: string); -} - -declare interface ResponseTransformer { - (json: any): T; -} - -declare namespace runtime { - export { - querystring, - mapValues, - canConsumeForm, - BASE_PATH, - ConfigurationParameters, - Configuration, - DefaultConfig, - BaseAPI, - ResponseError, - FetchError, - RequiredError, - COLLECTION_FORMATS, - FetchAPI, - Json, - HTTPMethod, - HTTPHeaders, - HTTPQuery, - HTTPBody, - HTTPRequestInit, - ModelPropertyNaming, - InitOverrideFunction, - FetchParams, - RequestOpts, - Consume, - RequestContext, - ResponseContext, - ErrorContext, - Middleware, - ApiResponse, - ResponseTransformer, - JSONApiResponse, - VoidApiResponse, - BlobApiResponse, - TextApiResponse - } -} - -declare class TextApiResponse { - raw: Response; - constructor(raw: Response); - value(): Promise; -} - -declare class VoidApiResponse { - raw: Response; - constructor(raw: Response); - value(): Promise; -} - -export { } - - -declare global { - namespace globalThis { - var PIM: PIM_SDK; - } -} diff --git a/dsm_sdk_script/fake_pim.js b/dsm_sdk_script/fake_pim.js new file mode 100644 index 0000000..17639d4 --- /dev/null +++ b/dsm_sdk_script/fake_pim.js @@ -0,0 +1,78 @@ +/// +globalThis.PIM = { + context: { + product: { + uuid: 'a289baa6-a59c-49dd-8146-9a0b8e7635fb', + identifier: 'My product identifier' + } + }, + api: { + products_uuid: { + get: () => new Promise(resolve => { + resolve({ + uuid: '37bd66c4-c665-4cc1-98d2-a3f5fcc9539a', + enabled: true, + family: 'digital_cameras', + categories: ['cameras_sales','digital_cameras'], + groups: [], + values: { + camera_type: [ + {locale: null, scope: null, data: 'compact', attribute_type: 'pim_catalog_simpleselect'} + ], + sku: [ + {locale: null, scope: null, data: '13710067', attribute_type: 'pim_catalog_identifier'} + ], + name: [ + { + locale: null, + scope: null, + data: 'Fujifilm FinePix S4200', + attribute_type: 'pim_catalog_text' + } + ], + total_megapixels: [ + {locale: null, scope: null, data: '16000000', attribute_type: 'pim_catalog_text'} + ], + weight: [ + { + locale: null, + scope: null, + data: {amount: '533.0000', unit: 'GRAM'}, + attribute_type: 'pim_catalog_metric' + } + ], + description: [ + { + locale: 'en_US', + scope: 'print', + data: "Long 24x optical zoom\\nThe combination of versatile & functional Fujinon lens and a bright viewfinder gives a sensational shooting experience.\\n\\nSR AUTO & Detection Functions\\nEquipped with SR AUTO, an auto 6 scene-recognition function fully loaded with detection functions that finds faces, blinks and smiles for clear optimised people photos.\\n\\nHigh Performance Shooting Functions\\nIntroducing high-performance shooting functions of Motion Panorama, Super Macro, Tracking Auto Focus, Instant Zoom and a Zoom Bracketing Mode.\\n\\nEasy Upload and Searching\\nShare pictures with friends and family, tagging pictures and movies for upload to FACEBOOK and YouTube™ right within your camera.", + attribute_type: 'pim_catalog_textarea' + } + ], + optical_zoom: [ + {locale: null, scope: null, data: 24, attribute_type: 'pim_catalog_number'} + ], + release_date: [ + { + locale: null, + scope: 'ecommerce', + data: '2012-04-08T00:00:00+00:00', + attribute_type: 'pim_catalog_date' + } + ], + auto_exposure: [ + {locale: null, scope: null, data: false, attribute_type: 'pim_catalog_boolean'} + ], + }, + associations: {}, + quantifiedAssociations: {}, + created: '2024-10-16T14:40:41+00:00', + updated: '2024-10-16T14:40:41+00:00', + metadata: { + workflowStatus: 'working_copy' + } + }); + }) + } + } +} diff --git a/dsm_sdk_script/global.d.ts b/dsm_sdk_script/global.d.ts new file mode 100644 index 0000000..fbcaba8 --- /dev/null +++ b/dsm_sdk_script/global.d.ts @@ -0,0 +1,2131 @@ +declare interface ApiResponse { + raw: Response; + value(): Promise; +} + +/** + * + * @export + * @interface Attributes + */ +declare interface Attributes { + /** + * + * @type {ProductsAllOfLinks} + * @memberof Attributes + */ + links?: ProductsAllOfLinks; + /** + * Current page number + * @type {number} + * @memberof Attributes + */ + currentPage?: number; + /** + * + * @type {AttributesAllOfEmbedded} + * @memberof Attributes + */ + embedded?: AttributesAllOfEmbedded; +} + +/** + * + * @export + * @interface AttributesAllOfEmbedded + */ +declare interface AttributesAllOfEmbedded { + /** + * + * @type {Array} + * @memberof AttributesAllOfEmbedded + */ + items?: Array; +} + +/** + * + * @export + * @interface AttributesAllOfEmbeddedItemsInner + */ +declare interface AttributesAllOfEmbeddedItemsInner { + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfLinks} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + links?: ProductsAllOfEmbeddedItemsInnerAllOfLinks; + /** + * Attribute code + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + code: string; + /** + * Attribute type. See type section for more details. + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + type: AttributesAllOfEmbeddedItemsInnerTypeEnum; + /** + * + * @type {AttributesAllOfEmbeddedItemsInnerAllOfLabels} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + labels?: AttributesAllOfEmbeddedItemsInnerAllOfLabels; + /** + * Attribute group + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + group: string; + /** + * + * @type {AttributesAllOfEmbeddedItemsInnerAllOfGroupLabels} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + groupLabels?: AttributesAllOfEmbeddedItemsInnerAllOfGroupLabels; + /** + * Order of the attribute in its group + * @type {number} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + sortOrder?: number; + /** + * Whether the attribute is localizable, i.e. can have one value by locale + * @type {boolean} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + localizable?: boolean; + /** + * Whether the attribute is scopable, i.e. can have one value by channel + * @type {boolean} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + scopable?: boolean; + /** + * To make the attribute locale specfic, specify here for which locales it is specific + * @type {Array} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + availableLocales?: Array; + /** + * Whether two values for the attribute cannot be the same + * @type {boolean} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + unique?: boolean; + /** + * Whether the attribute can be used as a filter for the product grid in the PIM user interface + * @type {boolean} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + useableAsGridFilter?: boolean; + /** + * Number maximum of characters allowed for the value of the attribute when the attribute type is `pim_catalog_text`, `pim_catalog_textarea` or `pim_catalog_identifier` + * @type {number} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + maxCharacters?: number; + /** + * Validation rule type used to validate any attribute value when the attribute type is `pim_catalog_text` or `pim_catalog_identifier` + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + validationRule?: string; + /** + * Regexp expression used to validate any attribute value when the attribute type is `pim_catalog_text` or `pim_catalog_identifier` + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + validationRegexp?: string; + /** + * Whether the WYSIWYG interface is shown when the attribute type is `pim_catalog_textarea` + * @type {boolean} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + wysiwygEnabled?: boolean; + /** + * Minimum integer value allowed when the attribute type is `pim_catalog_metric`, `pim_catalog_price` or `pim_catalog_number` + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + numberMin?: string; + /** + * Maximum integer value allowed when the attribute type is `pim_catalog_metric`, `pim_catalog_price` or `pim_catalog_number` + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + numberMax?: string; + /** + * Whether decimals are allowed when the attribute type is `pim_catalog_metric`, `pim_catalog_price` or `pim_catalog_number` + * @type {boolean} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + decimalsAllowed?: boolean; + /** + * Whether negative values are allowed when the attribute type is `pim_catalog_metric` or `pim_catalog_number` + * @type {boolean} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + negativeAllowed?: boolean; + /** + * Metric family when the attribute type is `pim_catalog_metric` + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + metricFamily?: string; + /** + * Default metric unit when the attribute type is `pim_catalog_metric` + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + defaultMetricUnit?: string; + /** + * Minimum date allowed when the attribute type is `pim_catalog_date` + * @type {Date} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + dateMin?: Date; + /** + * Maximum date allowed when the attribute type is `pim_catalog_date` + * @type {Date} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + dateMax?: Date; + /** + * Extensions allowed when the attribute type is `pim_catalog_file` or `pim_catalog_image` + * @type {Array} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + allowedExtensions?: Array; + /** + * Max file size in MB when the attribute type is `pim_catalog_file` or `pim_catalog_image` + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + maxFileSize?: string; + /** + * Reference entity code when the attribute type is `akeneo_reference_entity` or `akeneo_reference_entity_collection` OR Asset family code when the attribute type is `pim_catalog_asset_collection` + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + referenceDataName?: string; + /** + * Default value for a Yes/No attribute, applied when creating a new product or product model (only available since the 5.0) + * @type {boolean} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + defaultValue?: boolean; + /** + * Configuration of the Table attribute (columns) + * @type {Array} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + tableConfiguration?: Array; + /** + * Is this attribute main identifier when attribute type is `pim_catalog_identifier` + * @type {boolean} + * @memberof AttributesAllOfEmbeddedItemsInner + */ + isMainIdentifier?: boolean; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * Group labels for each locale + * @export + * @interface AttributesAllOfEmbeddedItemsInnerAllOfGroupLabels + */ +declare interface AttributesAllOfEmbeddedItemsInnerAllOfGroupLabels { + /** + * Group label for the locale `localeCode` + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfGroupLabels + */ + localeCode?: string; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * Attribute labels for each locale + * @export + * @interface AttributesAllOfEmbeddedItemsInnerAllOfLabels + */ +declare interface AttributesAllOfEmbeddedItemsInnerAllOfLabels { + /** + * Attribute label for the locale `localeCode` + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfLabels + */ + localeCode?: string; +} + +/** + * + * @export + * @interface AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInner + */ +declare interface AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInner { + /** + * Column code + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInner + */ + code: string; + /** + * Column data type + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInner + */ + dataType: AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerDataTypeEnum; + /** + * + * @type {AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerValidations} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInner + */ + validations?: AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerValidations; + /** + * + * @type {AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerLabels} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInner + */ + labels?: AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerLabels; + /** + * Defines if the column should be entirely filled for the attribute to be considered complete + * @type {boolean} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInner + */ + isRequiredForCompleteness?: boolean; +} + +/** + * @export + */ +declare const AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerDataTypeEnum: { + readonly Select: "select"; + readonly Text: "text"; + readonly Number: "number"; + readonly Boolean: "boolean"; +}; + +declare type AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerDataTypeEnum = typeof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerDataTypeEnum[keyof typeof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerDataTypeEnum]; + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * Column labels for each locale + * @export + * @interface AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerLabels + */ +declare interface AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerLabels { + /** + * Column label for the locale `localeCode` + * @type {string} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerLabels + */ + localeCode?: string; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * User defined validation constraints on the cell content + * @export + * @interface AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerValidations + */ +declare interface AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerValidations { + /** + * minimum value of a numeric cell + * @type {number} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerValidations + */ + min?: number; + /** + * maximum value of a numeric cell + * @type {number} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerValidations + */ + max?: number; + /** + * whether the value of a numeric cell can hold a decimal part + * @type {boolean} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerValidations + */ + decimalsAllowed?: boolean; + /** + * maximum length of a text cell + * @type {number} + * @memberof AttributesAllOfEmbeddedItemsInnerAllOfTableConfigurationInnerValidations + */ + maxLength?: number; +} + +/** + * @export + */ +declare const AttributesAllOfEmbeddedItemsInnerTypeEnum: { + readonly PimCatalogIdentifier: "pim_catalog_identifier"; + readonly PimCatalogMetric: "pim_catalog_metric"; + readonly PimCatalogNumber: "pim_catalog_number"; + readonly PimCatalogReferenceDataMultiSelect: "pim_catalog_reference_data_multi_select"; + readonly PimCatalogReferenceDataSimpleSelect: "pim_catalog_reference_data_simple_select"; + readonly PimCatalogSimpleselect: "pim_catalog_simpleselect"; + readonly PimCatalogMultiselect: "pim_catalog_multiselect"; + readonly PimCatalogDate: "pim_catalog_date"; + readonly PimCatalogTextarea: "pim_catalog_textarea"; + readonly PimCatalogText: "pim_catalog_text"; + readonly PimCatalogFile: "pim_catalog_file"; + readonly PimCatalogImage: "pim_catalog_image"; + readonly PimCatalogPriceCollection: "pim_catalog_price_collection"; + readonly PimCatalogBoolean: "pim_catalog_boolean"; + readonly AkeneoReferenceEntity: "akeneo_reference_entity"; + readonly AkeneoReferenceEntityCollection: "akeneo_reference_entity_collection"; + readonly PimCatalogAssetCollection: "pim_catalog_asset_collection"; +}; + +declare type AttributesAllOfEmbeddedItemsInnerTypeEnum = typeof AttributesAllOfEmbeddedItemsInnerTypeEnum[keyof typeof AttributesAllOfEmbeddedItemsInnerTypeEnum]; + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +declare const BASE_PATH: string; + +/** + * This is the base class for all generated API classes. + */ +declare class BaseAPI { + protected configuration: Configuration; + private static readonly jsonRegex; + private middleware; + constructor(configuration?: Configuration); + withMiddleware(this: T, ...middlewares: Middleware[]): T; + withPreMiddleware(this: T, ...preMiddlewares: Array): T; + withPostMiddleware(this: T, ...postMiddlewares: Array): T; + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/vnd.company+json + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + protected isJsonMime(mime: string | null | undefined): boolean; + protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise; + private createFetchParams; + private fetchApi; + /** + * Create a shallow clone of `this` by constructing a new instance + * and then shallow cloning data members. + */ + private clone; +} + +declare class BlobApiResponse { + raw: Response; + constructor(raw: Response); + value(): Promise; +} + +declare function canConsumeForm(consumes: Consume[]): boolean; + +/** + * + * @export + * @interface Categories + */ +declare interface Categories { + /** + * + * @type {ProductsAllOfLinks} + * @memberof Categories + */ + links?: ProductsAllOfLinks; + /** + * Current page number + * @type {number} + * @memberof Categories + */ + currentPage?: number; + /** + * + * @type {CategoriesAllOfEmbedded} + * @memberof Categories + */ + embedded?: CategoriesAllOfEmbedded; +} + +/** + * + * @export + * @interface CategoriesAllOfEmbedded + */ +declare interface CategoriesAllOfEmbedded { + /** + * + * @type {Array} + * @memberof CategoriesAllOfEmbedded + */ + items?: Array; +} + +/** + * + * @export + * @interface CategoriesAllOfEmbeddedItemsInner + */ +declare interface CategoriesAllOfEmbeddedItemsInner { + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfLinks} + * @memberof CategoriesAllOfEmbeddedItemsInner + */ + links?: ProductsAllOfEmbeddedItemsInnerAllOfLinks; + /** + * Category code + * @type {string} + * @memberof CategoriesAllOfEmbeddedItemsInner + */ + code: string; + /** + * Category code of the parent's category + * @type {string} + * @memberof CategoriesAllOfEmbeddedItemsInner + */ + parent?: string; + /** + * Date of the last update + * @type {string} + * @memberof CategoriesAllOfEmbeddedItemsInner + */ + updated?: string; + /** + * Position of the category in its level, start from 1 (only available since the 7.0 version and when query parameter "with_position" is set to "true") + * @type {number} + * @memberof CategoriesAllOfEmbeddedItemsInner + */ + position?: number; + /** + * + * @type {CategoriesAllOfEmbeddedItemsInnerAllOfLabels} + * @memberof CategoriesAllOfEmbeddedItemsInner + */ + labels?: CategoriesAllOfEmbeddedItemsInnerAllOfLabels; + /** + * + * @type {CategoriesAllOfEmbeddedItemsInnerAllOfValues} + * @memberof CategoriesAllOfEmbeddedItemsInner + */ + values?: CategoriesAllOfEmbeddedItemsInnerAllOfValues; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * Category labels for each locale + * @export + * @interface CategoriesAllOfEmbeddedItemsInnerAllOfLabels + */ +declare interface CategoriesAllOfEmbeddedItemsInnerAllOfLabels { + /** + * Category label for the locale `localeCode` + * @type {string} + * @memberof CategoriesAllOfEmbeddedItemsInnerAllOfLabels + */ + localeCode?: string; +} + +/** + * Attribute values + * @export + * @interface CategoriesAllOfEmbeddedItemsInnerAllOfValues + */ +declare interface CategoriesAllOfEmbeddedItemsInnerAllOfValues { + /** + * + * @type {Array} + * @memberof CategoriesAllOfEmbeddedItemsInnerAllOfValues + */ + attributeCodeAttributeUuidChannelCodeLocaleCode?: Array; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * + * @export + * @interface CategoriesAllOfEmbeddedItemsInnerAllOfValuesAttributeCodeAttributeUuidChannelCodeLocaleCodeInner + */ +declare interface CategoriesAllOfEmbeddedItemsInnerAllOfValuesAttributeCodeAttributeUuidChannelCodeLocaleCodeInner { + /** + * Attribute value + * @type {object} + * @memberof CategoriesAllOfEmbeddedItemsInnerAllOfValuesAttributeCodeAttributeUuidChannelCodeLocaleCodeInner + */ + data?: object; + /** + * The attribute type + * @type {string} + * @memberof CategoriesAllOfEmbeddedItemsInnerAllOfValuesAttributeCodeAttributeUuidChannelCodeLocaleCodeInner + */ + type?: string; + /** + * Locale code of the attribute value + * @type {string} + * @memberof CategoriesAllOfEmbeddedItemsInnerAllOfValuesAttributeCodeAttributeUuidChannelCodeLocaleCodeInner + */ + locale?: string; + /** + * Channel code of the attribute value + * @type {string} + * @memberof CategoriesAllOfEmbeddedItemsInnerAllOfValuesAttributeCodeAttributeUuidChannelCodeLocaleCodeInner + */ + channel?: string; + /** + * The attribute code with its uuid (attributeCode|attributeUuid) + * @type {string} + * @memberof CategoriesAllOfEmbeddedItemsInnerAllOfValuesAttributeCodeAttributeUuidChannelCodeLocaleCodeInner + */ + attributeCode?: string; +} + +declare const COLLECTION_FORMATS: { + csv: string; + ssv: string; + tsv: string; + pipes: string; +}; + +declare class Configuration { + private configuration; + constructor(configuration?: ConfigurationParameters); + set config(configuration: Configuration); + get basePath(): string; + get fetchApi(): FetchAPI | undefined; + get middleware(): Middleware[]; + get queryParamsStringify(): (params: HTTPQuery) => string; + get username(): string | undefined; + get password(): string | undefined; + get apiKey(): ((name: string) => string | Promise) | undefined; + get accessToken(): ((name?: string, scopes?: string[]) => string | Promise) | undefined; + get headers(): HTTPHeaders | undefined; + get credentials(): RequestCredentials | undefined; +} + +declare interface ConfigurationParameters { + basePath?: string; + fetchApi?: FetchAPI; + middleware?: Middleware[]; + queryParamsStringify?: (params: HTTPQuery) => string; + username?: string; + password?: string; + apiKey?: string | Promise | ((name: string) => string | Promise); + accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string | Promise); + headers?: HTTPHeaders; + credentials?: RequestCredentials; +} + +declare interface Consume { + contentType: string; +} + +declare const DefaultConfig: Configuration; + +declare interface DeleteProductsUuidUuidRequest { + uuid: string; +} + +declare interface ErrorContext { + fetch: FetchAPI; + url: string; + init: RequestInit; + error: unknown; + response?: Response; +} + +/** + * + * @export + * @interface Families + */ +declare interface Families { + /** + * + * @type {ProductsAllOfLinks} + * @memberof Families + */ + links?: ProductsAllOfLinks; + /** + * Current page number + * @type {number} + * @memberof Families + */ + currentPage?: number; + /** + * + * @type {FamiliesAllOfEmbedded} + * @memberof Families + */ + embedded?: FamiliesAllOfEmbedded; +} + +/** + * + * @export + * @interface FamiliesAllOfEmbedded + */ +declare interface FamiliesAllOfEmbedded { + /** + * + * @type {Array} + * @memberof FamiliesAllOfEmbedded + */ + items?: Array; +} + +/** + * + * @export + * @interface FamiliesAllOfEmbeddedItemsInner + */ +declare interface FamiliesAllOfEmbeddedItemsInner { + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfLinks} + * @memberof FamiliesAllOfEmbeddedItemsInner + */ + links?: ProductsAllOfEmbeddedItemsInnerAllOfLinks; + /** + * Family code + * @type {string} + * @memberof FamiliesAllOfEmbeddedItemsInner + */ + code: string; + /** + * Attribute code used as label + * @type {string} + * @memberof FamiliesAllOfEmbeddedItemsInner + */ + attributeAsLabel: string; + /** + * Attribute code used as the main picture in the user interface (only since v2.0) + * @type {string} + * @memberof FamiliesAllOfEmbeddedItemsInner + */ + attributeAsImage?: string; + /** + * Attributes codes that compose the family + * @type {Array} + * @memberof FamiliesAllOfEmbeddedItemsInner + */ + attributes?: Array; + /** + * + * @type {FamiliesAllOfEmbeddedItemsInnerAllOfAttributeRequirements} + * @memberof FamiliesAllOfEmbeddedItemsInner + */ + attributeRequirements?: FamiliesAllOfEmbeddedItemsInnerAllOfAttributeRequirements; + /** + * + * @type {FamiliesAllOfEmbeddedItemsInnerAllOfLabels} + * @memberof FamiliesAllOfEmbeddedItemsInner + */ + labels?: FamiliesAllOfEmbeddedItemsInnerAllOfLabels; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * Attributes codes of the family that are required for the completeness calculation for each channel + * @export + * @interface FamiliesAllOfEmbeddedItemsInnerAllOfAttributeRequirements + */ +declare interface FamiliesAllOfEmbeddedItemsInnerAllOfAttributeRequirements { + /** + * + * @type {Array} + * @memberof FamiliesAllOfEmbeddedItemsInnerAllOfAttributeRequirements + */ + channelCode?: Array; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * Family labels for each locale + * @export + * @interface FamiliesAllOfEmbeddedItemsInnerAllOfLabels + */ +declare interface FamiliesAllOfEmbeddedItemsInnerAllOfLabels { + /** + * Family label for the locale `localeCode` + * @type {string} + * @memberof FamiliesAllOfEmbeddedItemsInnerAllOfLabels + */ + localeCode?: string; +} + +declare type FetchAPI = WindowOrWorkerGlobalScope['fetch']; + +declare class FetchError extends Error { + cause: Error; + name: "FetchError"; + constructor(cause: Error, msg?: string); +} + +declare interface FetchParams { + url: string; + init: RequestInit; +} + +declare interface GetAttributesCodeRequest { + code: string; + withTableSelectOptions?: boolean; +} + +declare interface GetAttributesRequest { + search?: string; + page?: number; + limit?: number; + withCount?: boolean; + withTableSelectOptions?: boolean; +} + +/** + * + * @export + * @interface GetCategoriesCode200Response + */ +declare interface GetCategoriesCode200Response { + /** + * Category code + * @type {string} + * @memberof GetCategoriesCode200Response + */ + code: string; + /** + * Category code of the parent's category + * @type {string} + * @memberof GetCategoriesCode200Response + */ + parent?: string; + /** + * Date of the last update + * @type {string} + * @memberof GetCategoriesCode200Response + */ + updated?: string; + /** + * Position of the category in its level, start from 1 (only available since the 7.0 version and when query parameter "with_position" is set to "true") + * @type {number} + * @memberof GetCategoriesCode200Response + */ + position?: number; + /** + * + * @type {CategoriesAllOfEmbeddedItemsInnerAllOfLabels} + * @memberof GetCategoriesCode200Response + */ + labels?: CategoriesAllOfEmbeddedItemsInnerAllOfLabels; + /** + * + * @type {CategoriesAllOfEmbeddedItemsInnerAllOfValues} + * @memberof GetCategoriesCode200Response + */ + values?: CategoriesAllOfEmbeddedItemsInnerAllOfValues; +} + +declare interface GetCategoriesCodeRequest { + code: string; + withPosition?: boolean; + withEnrichedAttributes?: boolean; +} + +declare interface GetCategoriesRequest { + search?: string; + page?: number; + limit?: number; + withCount?: boolean; + withPosition?: boolean; + withEnrichedAttributes?: boolean; +} + +declare interface GetFamiliesCodeRequest { + code: string; +} + +declare interface GetFamiliesRequest { + search?: string; + page?: number; + limit?: number; + withCount?: boolean; +} + +/** + * @export + */ +declare const GetProductsUuidPaginationTypeEnum: { + readonly Page: "page"; + readonly SearchAfter: "search_after"; +}; + +declare type GetProductsUuidPaginationTypeEnum = typeof GetProductsUuidPaginationTypeEnum[keyof typeof GetProductsUuidPaginationTypeEnum]; + +declare interface GetProductsUuidRequest { + search?: string; + scope?: string; + locales?: string; + attributes?: string; + paginationType?: GetProductsUuidPaginationTypeEnum; + page?: number; + searchAfter?: string; + limit?: number; + withCount?: boolean; + withAttributeOptions?: boolean; + withAssetShareLinks?: boolean; + withQualityScores?: boolean; + withCompletenesses?: boolean; +} + +declare interface GetProductsUuidUuidRequest { + uuid: string; + withAttributeOptions?: boolean; + withAssetShareLinks?: boolean; + withQualityScores?: boolean; + withCompletenesses?: boolean; +} + +declare type HTTPBody = Json | FormData | URLSearchParams; + +declare type HTTPHeaders = { + [key: string]: string; +}; + +declare type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD'; + +declare type HTTPQuery = { + [key: string]: string | number | null | boolean | Array | Set | HTTPQuery; +}; + +declare type HTTPRequestInit = { + headers?: HTTPHeaders; + method: HTTPMethod; + credentials?: RequestCredentials; + body?: HTTPBody; +}; + +declare type InitOverrideFunction = (requestContext: { + init: HTTPRequestInit; + context: RequestOpts; +}) => Promise; + +declare type Json = any; + +declare class JSONApiResponse { + raw: Response; + private transformer; + constructor(raw: Response, transformer?: ResponseTransformer); + value(): Promise; +} + +declare function mapValues(data: any, fn: (item: any) => any): {}; + +declare interface Middleware { + pre?(context: RequestContext): Promise; + post?(context: ResponseContext): Promise; + onError?(context: ErrorContext): Promise; +} + +declare type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original'; + +declare interface PatchProductsUuidUuidRequest { + uuid: string; + body: PostProductsUuidRequest; +} + +export declare type PIM_CONTEXT = { + product: { + uuid: string; + identifier: string | null; + }; +}; + +export declare type PIM_SDK = { + user: PIM_USER; + context: PIM_CONTEXT; + api: { + products_uuid: SdkApiProductsUuid; + attribute: SdkApiAttribute; + family: SdkApiFamily; + category: SdkApiCategory; + }; +}; + +export declare type PIM_USER = { + username: string; + first_name: string; + last_name: string; +}; + +/** + * + * @export + * @interface PostAttributesRequest + */ +declare interface PostAttributesRequest { + /** + * Attribute code + * @type {string} + * @memberof PostAttributesRequest + */ + code: string; + /** + * Attribute type. See type section for more details. + * @type {string} + * @memberof PostAttributesRequest + */ + type: PostAttributesRequestTypeEnum; + /** + * + * @type {AttributesAllOfEmbeddedItemsInnerAllOfLabels} + * @memberof PostAttributesRequest + */ + labels?: AttributesAllOfEmbeddedItemsInnerAllOfLabels; + /** + * Attribute group + * @type {string} + * @memberof PostAttributesRequest + */ + group: string; + /** + * + * @type {AttributesAllOfEmbeddedItemsInnerAllOfGroupLabels} + * @memberof PostAttributesRequest + */ + groupLabels?: AttributesAllOfEmbeddedItemsInnerAllOfGroupLabels; + /** + * Order of the attribute in its group + * @type {number} + * @memberof PostAttributesRequest + */ + sortOrder?: number; + /** + * Whether the attribute is localizable, i.e. can have one value by locale + * @type {boolean} + * @memberof PostAttributesRequest + */ + localizable?: boolean; + /** + * Whether the attribute is scopable, i.e. can have one value by channel + * @type {boolean} + * @memberof PostAttributesRequest + */ + scopable?: boolean; + /** + * To make the attribute locale specfic, specify here for which locales it is specific + * @type {Array} + * @memberof PostAttributesRequest + */ + availableLocales?: Array; + /** + * Whether two values for the attribute cannot be the same + * @type {boolean} + * @memberof PostAttributesRequest + */ + unique?: boolean; + /** + * Whether the attribute can be used as a filter for the product grid in the PIM user interface + * @type {boolean} + * @memberof PostAttributesRequest + */ + useableAsGridFilter?: boolean; + /** + * Number maximum of characters allowed for the value of the attribute when the attribute type is `pim_catalog_text`, `pim_catalog_textarea` or `pim_catalog_identifier` + * @type {number} + * @memberof PostAttributesRequest + */ + maxCharacters?: number; + /** + * Validation rule type used to validate any attribute value when the attribute type is `pim_catalog_text` or `pim_catalog_identifier` + * @type {string} + * @memberof PostAttributesRequest + */ + validationRule?: string; + /** + * Regexp expression used to validate any attribute value when the attribute type is `pim_catalog_text` or `pim_catalog_identifier` + * @type {string} + * @memberof PostAttributesRequest + */ + validationRegexp?: string; + /** + * Whether the WYSIWYG interface is shown when the attribute type is `pim_catalog_textarea` + * @type {boolean} + * @memberof PostAttributesRequest + */ + wysiwygEnabled?: boolean; + /** + * Minimum integer value allowed when the attribute type is `pim_catalog_metric`, `pim_catalog_price` or `pim_catalog_number` + * @type {string} + * @memberof PostAttributesRequest + */ + numberMin?: string; + /** + * Maximum integer value allowed when the attribute type is `pim_catalog_metric`, `pim_catalog_price` or `pim_catalog_number` + * @type {string} + * @memberof PostAttributesRequest + */ + numberMax?: string; + /** + * Whether decimals are allowed when the attribute type is `pim_catalog_metric`, `pim_catalog_price` or `pim_catalog_number` + * @type {boolean} + * @memberof PostAttributesRequest + */ + decimalsAllowed?: boolean; + /** + * Whether negative values are allowed when the attribute type is `pim_catalog_metric` or `pim_catalog_number` + * @type {boolean} + * @memberof PostAttributesRequest + */ + negativeAllowed?: boolean; + /** + * Metric family when the attribute type is `pim_catalog_metric` + * @type {string} + * @memberof PostAttributesRequest + */ + metricFamily?: string; + /** + * Default metric unit when the attribute type is `pim_catalog_metric` + * @type {string} + * @memberof PostAttributesRequest + */ + defaultMetricUnit?: string; + /** + * Minimum date allowed when the attribute type is `pim_catalog_date` + * @type {Date} + * @memberof PostAttributesRequest + */ + dateMin?: Date; + /** + * Maximum date allowed when the attribute type is `pim_catalog_date` + * @type {Date} + * @memberof PostAttributesRequest + */ + dateMax?: Date; + /** + * Extensions allowed when the attribute type is `pim_catalog_file` or `pim_catalog_image` + * @type {Array} + * @memberof PostAttributesRequest + */ + allowedExtensions?: Array; + /** + * Max file size in MB when the attribute type is `pim_catalog_file` or `pim_catalog_image` + * @type {string} + * @memberof PostAttributesRequest + */ + maxFileSize?: string; + /** + * Reference entity code when the attribute type is `akeneo_reference_entity` or `akeneo_reference_entity_collection` OR Asset family code when the attribute type is `pim_catalog_asset_collection` + * @type {string} + * @memberof PostAttributesRequest + */ + referenceDataName?: string; + /** + * Default value for a Yes/No attribute, applied when creating a new product or product model (only available since the 5.0) + * @type {boolean} + * @memberof PostAttributesRequest + */ + defaultValue?: boolean; + /** + * Configuration of the Table attribute (columns) + * @type {Array} + * @memberof PostAttributesRequest + */ + tableConfiguration?: Array; + /** + * Is this attribute main identifier when attribute type is `pim_catalog_identifier` + * @type {boolean} + * @memberof PostAttributesRequest + */ + isMainIdentifier?: boolean; +} + +/** + * @export + */ +declare const PostAttributesRequestTypeEnum: { + readonly PimCatalogIdentifier: "pim_catalog_identifier"; + readonly PimCatalogMetric: "pim_catalog_metric"; + readonly PimCatalogNumber: "pim_catalog_number"; + readonly PimCatalogReferenceDataMultiSelect: "pim_catalog_reference_data_multi_select"; + readonly PimCatalogReferenceDataSimpleSelect: "pim_catalog_reference_data_simple_select"; + readonly PimCatalogSimpleselect: "pim_catalog_simpleselect"; + readonly PimCatalogMultiselect: "pim_catalog_multiselect"; + readonly PimCatalogDate: "pim_catalog_date"; + readonly PimCatalogTextarea: "pim_catalog_textarea"; + readonly PimCatalogText: "pim_catalog_text"; + readonly PimCatalogFile: "pim_catalog_file"; + readonly PimCatalogImage: "pim_catalog_image"; + readonly PimCatalogPriceCollection: "pim_catalog_price_collection"; + readonly PimCatalogBoolean: "pim_catalog_boolean"; + readonly AkeneoReferenceEntity: "akeneo_reference_entity"; + readonly AkeneoReferenceEntityCollection: "akeneo_reference_entity_collection"; + readonly PimCatalogAssetCollection: "pim_catalog_asset_collection"; +}; + +declare type PostAttributesRequestTypeEnum = typeof PostAttributesRequestTypeEnum[keyof typeof PostAttributesRequestTypeEnum]; + +/** + * + * @export + * @interface PostFamiliesRequest + */ +declare interface PostFamiliesRequest { + /** + * Family code + * @type {string} + * @memberof PostFamiliesRequest + */ + code: string; + /** + * Attribute code used as label + * @type {string} + * @memberof PostFamiliesRequest + */ + attributeAsLabel: string; + /** + * Attribute code used as the main picture in the user interface (only since v2.0) + * @type {string} + * @memberof PostFamiliesRequest + */ + attributeAsImage?: string; + /** + * Attributes codes that compose the family + * @type {Array} + * @memberof PostFamiliesRequest + */ + attributes?: Array; + /** + * + * @type {FamiliesAllOfEmbeddedItemsInnerAllOfAttributeRequirements} + * @memberof PostFamiliesRequest + */ + attributeRequirements?: FamiliesAllOfEmbeddedItemsInnerAllOfAttributeRequirements; + /** + * + * @type {FamiliesAllOfEmbeddedItemsInnerAllOfLabels} + * @memberof PostFamiliesRequest + */ + labels?: FamiliesAllOfEmbeddedItemsInnerAllOfLabels; +} + +/** + * + * @export + * @interface PostProductsUuidRequest + */ +declare interface PostProductsUuidRequest { + /** + * Product uuid + * @type {string} + * @memberof PostProductsUuidRequest + */ + uuid?: string; + /** + * Whether the product is enabled + * @type {boolean} + * @memberof PostProductsUuidRequest + */ + enabled?: boolean; + /** + * Family code from which the product inherits its attributes and attributes requirements. + * @type {string} + * @memberof PostProductsUuidRequest + */ + family?: string; + /** + * Codes of the categories in which the product is classified + * @type {Array} + * @memberof PostProductsUuidRequest + */ + categories?: Array; + /** + * Codes of the groups to which the product belong + * @type {Array} + * @memberof PostProductsUuidRequest + */ + groups?: Array; + /** + * Code of the parent product model when the product is a variant (only available since the 2.0). This parent can be modified since the 2.3. + * @type {string} + * @memberof PostProductsUuidRequest + */ + parent?: string; + /** + * Product attributes values, see Product values section for more details + * @type {{ [key: string]: Array; }} + * @memberof PostProductsUuidRequest + */ + values?: { + [key: string]: Array; + }; + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfAssociations} + * @memberof PostProductsUuidRequest + */ + associations?: ProductsAllOfEmbeddedItemsInnerAllOfAssociations; + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations} + * @memberof PostProductsUuidRequest + */ + quantifiedAssociations?: ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations; + /** + * Date of creation + * @type {string} + * @memberof PostProductsUuidRequest + */ + created?: string; + /** + * Date of the last update + * @type {string} + * @memberof PostProductsUuidRequest + */ + updated?: string; + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfMetadata} + * @memberof PostProductsUuidRequest + */ + metadata?: ProductsAllOfEmbeddedItemsInnerAllOfMetadata; + /** + * Product quality scores for each channel/locale combination (only available since the 5.0 and when the "with_quality_scores" query parameter is set to "true") + * @type {object} + * @memberof PostProductsUuidRequest + */ + qualityScores?: object; + /** + * Product completenesses for each channel/locale combination (only available since the 7.0 version, and when the "with_completenesses" query parameter is set to "true") + * @type {Array} + * @memberof PostProductsUuidRequest + */ + completenesses?: Array; +} + +/** + * + * @export + * @interface Products + */ +declare interface Products { + /** + * + * @type {ProductsAllOfLinks} + * @memberof Products + */ + links?: ProductsAllOfLinks; + /** + * Current page number + * @type {number} + * @memberof Products + */ + currentPage?: number; + /** + * + * @type {ProductsAllOfEmbedded} + * @memberof Products + */ + embedded?: ProductsAllOfEmbedded; +} + +/** + * + * @export + * @interface ProductsAllOfEmbedded + */ +declare interface ProductsAllOfEmbedded { + /** + * + * @type {Array} + * @memberof ProductsAllOfEmbedded + */ + items?: Array; +} + +/** + * + * @export + * @interface ProductsAllOfEmbeddedItemsInner + */ +declare interface ProductsAllOfEmbeddedItemsInner { + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfLinks} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + links?: ProductsAllOfEmbeddedItemsInnerAllOfLinks; + /** + * Product uuid + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + uuid?: string; + /** + * Whether the product is enabled + * @type {boolean} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + enabled?: boolean; + /** + * Family code from which the product inherits its attributes and attributes requirements. + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + family?: string; + /** + * Codes of the categories in which the product is classified + * @type {Array} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + categories?: Array; + /** + * Codes of the groups to which the product belong + * @type {Array} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + groups?: Array; + /** + * Code of the parent product model when the product is a variant (only available since the 2.0). This parent can be modified since the 2.3. + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + parent?: string; + /** + * Product attributes values, see Product values section for more details + * @type {{ [key: string]: Array; }} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + values?: { + [key: string]: Array; + }; + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfAssociations} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + associations?: ProductsAllOfEmbeddedItemsInnerAllOfAssociations; + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + quantifiedAssociations?: ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations; + /** + * Date of creation + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + created?: string; + /** + * Date of the last update + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + updated?: string; + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfMetadata} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + metadata?: ProductsAllOfEmbeddedItemsInnerAllOfMetadata; + /** + * Product quality scores for each channel/locale combination (only available since the 5.0 and when the "with_quality_scores" query parameter is set to "true") + * @type {object} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + qualityScores?: object; + /** + * Product completenesses for each channel/locale combination (only available since the 7.0 version, and when the "with_completenesses" query parameter is set to "true") + * @type {Array} + * @memberof ProductsAllOfEmbeddedItemsInner + */ + completenesses?: Array; +} + +/** + * Several associations related to groups, product models and/or other products, grouped by association types + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfAssociations + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfAssociations { + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfAssociations + */ + associationTypeCode?: ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode { + /** + * Array of groups codes with which the product is in relation + * @type {Array} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode + */ + groups?: Array; + /** + * Array of product uuids with which the product is in relation + * @type {Array} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode + */ + products?: Array; + /** + * Array of product model codes with which the product is in relation (only available since the v2.1) + * @type {Array} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfAssociationsAssociationTypeCode + */ + productModels?: Array; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfCompletenessesInner + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfCompletenessesInner { + /** + * + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfCompletenessesInner + */ + scope?: string; + /** + * + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfCompletenessesInner + */ + locale?: string; + /** + * + * @type {number} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfCompletenessesInner + */ + data?: number; +} + +/** + * + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfLinks + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfLinks { + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfLinksSelf} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfLinks + */ + self?: ProductsAllOfEmbeddedItemsInnerAllOfLinksSelf; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfLinksSelf + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfLinksSelf { + /** + * URI of the resource + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfLinksSelf + */ + href?: string; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * More information around the product (only available since the v2.0 in the Enterprise Edition) + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfMetadata + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfMetadata { + /** + * Status of the product regarding the user permissions + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfMetadata + */ + workflowStatus?: ProductsAllOfEmbeddedItemsInnerAllOfMetadataWorkflowStatusEnum; +} + +/** + * @export + */ +declare const ProductsAllOfEmbeddedItemsInnerAllOfMetadataWorkflowStatusEnum: { + readonly ReadOnly: "read_only"; + readonly DraftInProgress: "draft_in_progress"; + readonly ProposalWaitingForApproval: "proposal_waiting_for_approval"; + readonly WorkingCopy: "working_copy"; +}; + +declare type ProductsAllOfEmbeddedItemsInnerAllOfMetadataWorkflowStatusEnum = typeof ProductsAllOfEmbeddedItemsInnerAllOfMetadataWorkflowStatusEnum[keyof typeof ProductsAllOfEmbeddedItemsInnerAllOfMetadataWorkflowStatusEnum]; + +/** + * Several quantified associations related to products and/or product models, grouped by quantified association types (only available since the 5.0) + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations { + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociations + */ + quantifiedAssociationTypeCode?: ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode; +} + +/** + * + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode { + /** + * Array of objects containing product uuids and quantities with which the product is in relation + * @type {Array} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode + */ + products?: Array; + /** + * Array of objects containing product model codes and quantities with which the product is in relation + * @type {Array} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCode + */ + productModels?: Array; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductModelsInner + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductModelsInner { + /** + * + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductModelsInner + */ + code?: string; + /** + * + * @type {number} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductModelsInner + */ + quantity?: number; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductsInner + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductsInner { + /** + * + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductsInner + */ + uuid?: string; + /** + * + * @type {number} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfQuantifiedAssociationsQuantifiedAssociationTypeCodeProductsInner + */ + quantity?: number; +} + +/** + * + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner { + /** + * Channel code of the product value + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner + */ + scope?: string; + /** + * Locale code of the product value + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner + */ + locale?: string; + /** + * Product value. See the `data` format section for more details. + * @type {object} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner + */ + data?: object; + /** + * + * @type {ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner + */ + linkedData?: ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData; + /** + * The type of the value's attribute. See type section for more details. + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner + */ + attributeType?: string; + /** + * Reference entity code when the attribute type is `akeneo_reference_entity` or `akeneo_reference_entity_collection` OR Asset family code when the attribute type is `pim_catalog_asset_collection` + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInner + */ + referenceDataName?: string; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * Object containing additional data when a related query parameter is enabled. See the `linked_data` format section for more details. (only available since the 5.0) + * @export + * @interface ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData + */ +declare interface ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData { + /** + * + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData + */ + attribute?: string; + /** + * + * @type {string} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData + */ + code?: string; + /** + * + * @type {object} + * @memberof ProductsAllOfEmbeddedItemsInnerAllOfValuesValueInnerLinkedData + */ + labels?: object; +} + +/** + * + * @export + * @interface ProductsAllOfLinks + */ +declare interface ProductsAllOfLinks { + /** + * + * @type {ProductsAllOfLinksSelf} + * @memberof ProductsAllOfLinks + */ + self?: ProductsAllOfLinksSelf; + /** + * + * @type {ProductsAllOfLinksFirst} + * @memberof ProductsAllOfLinks + */ + first?: ProductsAllOfLinksFirst; + /** + * + * @type {ProductsAllOfLinksPrevious} + * @memberof ProductsAllOfLinks + */ + previous?: ProductsAllOfLinksPrevious; + /** + * + * @type {ProductsAllOfLinksNext} + * @memberof ProductsAllOfLinks + */ + next?: ProductsAllOfLinksNext; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * + * @export + * @interface ProductsAllOfLinksFirst + */ +declare interface ProductsAllOfLinksFirst { + /** + * URI of the first page of resources + * @type {string} + * @memberof ProductsAllOfLinksFirst + */ + href?: string; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * + * @export + * @interface ProductsAllOfLinksNext + */ +declare interface ProductsAllOfLinksNext { + /** + * URI of the next page of resources + * @type {string} + * @memberof ProductsAllOfLinksNext + */ + href?: string; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * + * @export + * @interface ProductsAllOfLinksPrevious + */ +declare interface ProductsAllOfLinksPrevious { + /** + * URI of the previous page of resources + * @type {string} + * @memberof ProductsAllOfLinksPrevious + */ + href?: string; +} + +/** + * Akeneo PIM REST API + * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) + * + * The version of the OpenAPI document: 1.0.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ +/** + * + * @export + * @interface ProductsAllOfLinksSelf + */ +declare interface ProductsAllOfLinksSelf { + /** + * URI of the current page of resources + * @type {string} + * @memberof ProductsAllOfLinksSelf + */ + href?: string; +} + +declare function querystring(params: HTTPQuery, prefix?: string): string; + +declare interface RequestContext { + fetch: FetchAPI; + url: string; + init: RequestInit; +} + +declare interface RequestOpts { + path: string; + method: HTTPMethod; + headers: HTTPHeaders; + query?: HTTPQuery; + body?: HTTPBody; +} + +declare class RequiredError extends Error { + field: string; + name: "RequiredError"; + constructor(field: string, msg?: string); +} + +declare interface ResponseContext { + fetch: FetchAPI; + url: string; + init: RequestInit; + response: Response; +} + +declare class ResponseError extends Error { + response: Response; + name: "ResponseError"; + constructor(response: Response, msg?: string); +} + +declare interface ResponseTransformer { + (json: any): T; +} + +declare namespace runtime { + export { + querystring, + mapValues, + canConsumeForm, + BASE_PATH, + ConfigurationParameters, + Configuration, + DefaultConfig, + BaseAPI, + ResponseError, + FetchError, + RequiredError, + COLLECTION_FORMATS, + FetchAPI, + Json, + HTTPMethod, + HTTPHeaders, + HTTPQuery, + HTTPBody, + HTTPRequestInit, + ModelPropertyNaming, + InitOverrideFunction, + FetchParams, + RequestOpts, + Consume, + RequestContext, + ResponseContext, + ErrorContext, + Middleware, + ApiResponse, + ResponseTransformer, + JSONApiResponse, + VoidApiResponse, + BlobApiResponse, + TextApiResponse + } +} + +declare type SdkApiAttribute = { + get: (requestParameters: GetAttributesCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; + list: (requestParameters: GetAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; +}; + +declare type SdkApiCategory = { + get: (requestParameters: GetCategoriesCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; + list: (requestParameters: GetCategoriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; +}; + +declare type SdkApiFamily = { + get: (requestParameters: GetFamiliesCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; + list: (requestParameters: GetFamiliesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; +}; + +export declare type SdkApiProductsUuid = { + get: (requestParameters: GetProductsUuidUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; + list: (requestParameters: GetProductsUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; + upsert: (requestParameters: PatchProductsUuidUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; + delete: (requestParameters: DeleteProductsUuidUuidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction) => Promise; +}; + +declare class TextApiResponse { + raw: Response; + constructor(raw: Response); + value(): Promise; +} + +declare class VoidApiResponse { + raw: Response; + constructor(raw: Response); + value(): Promise; +} + +export { } + + +declare global { + namespace globalThis { + var PIM: PIM_SDK; + } +} diff --git a/dsm_sdk_script/index.html b/dsm_sdk_script/index.html index f46900a..98f43f2 100644 --- a/dsm_sdk_script/index.html +++ b/dsm_sdk_script/index.html @@ -10,6 +10,7 @@ var global = window; } +
diff --git a/dsm_sdk_script/src/App.tsx b/dsm_sdk_script/src/App.tsx index 3ab7ccf..3f52329 100644 --- a/dsm_sdk_script/src/App.tsx +++ b/dsm_sdk_script/src/App.tsx @@ -1,14 +1,17 @@ -import {Link, Placeholder, UsersIllustration} from "akeneo-design-system"; - -function App() { - return } - title="Welcome to the SDM SDK starter kit!" - > - Please update the src/App.tsx file to match your needs!
- Link to the official Akeneo DSM - +import * as React from "react"; +import {PIM_SDK} from "../global"; +import {useProduct} from "./useProduct.ts"; + +type AppProps = { + PIM: PIM_SDK +} + +const App: React.FC = ({PIM}) => { + const product = useProduct(PIM.context.product?.uuid); + + return <> + {product && JSON.stringify(product)} + } export default App diff --git a/dsm_sdk_script/src/main.tsx b/dsm_sdk_script/src/main.tsx index 35db8dd..a2fc66c 100644 --- a/dsm_sdk_script/src/main.tsx +++ b/dsm_sdk_script/src/main.tsx @@ -12,7 +12,7 @@ if (!document.getElementById('root')) { ReactDOM.render( - + , document.getElementById('root') diff --git a/dsm_sdk_script/src/useProduct.ts b/dsm_sdk_script/src/useProduct.ts new file mode 100644 index 0000000..91ca1fd --- /dev/null +++ b/dsm_sdk_script/src/useProduct.ts @@ -0,0 +1,15 @@ +import * as React from "react"; + +const useProduct = (uuid: string) => { + const [product, setProduct] = React.useState(); + + React.useEffect(() => { + uuid && PIM.api.products_uuid.get({uuid}).then((product) => { + setProduct(product); + }); + }, [uuid]); + + return product; +} + +export {useProduct};