Files

Shahed Nasser 914d773d3a api-ref: custom API reference (#4770 )

* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies

2023-08-15 18:07:54 +03:00

12 KiB

Raw Blame History

Class: SalesChannelService

Hierarchy

TransactionBaseService

↳ SalesChannelService

Constructors

constructor

• new SalesChannelService(__namedParameters)

Parameters

Name	Type
`__namedParameters`	`InjectedDependencies`

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/sales-channel.ts:34

Properties

configModule

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

container

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

moduleDeclaration

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

eventBusService_

• Protected Readonly eventBusService_: EventBusService

Defined in

medusa/src/services/sales-channel.ts:31

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

salesChannelRepository_

• Protected Readonly salesChannelRepository_: Repository<SalesChannel> & { addProducts: (salesChannelId: string, productIds: string[]) => Promise<void> ; getFreeTextSearchResultsAndCount: (q: string, options: ExtendedFindConfig<SalesChannel>) => Promise<[SalesChannel[], number]> ; removeProducts: (salesChannelId: string, productIds: string[]) => Promise<DeleteResult> }

Defined in

medusa/src/services/sales-channel.ts:30

storeService_

• Protected Readonly storeService_: StoreService

Defined in

medusa/src/services/sales-channel.ts:32

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Events

▪ Static Events: Object

Type declaration

Name	Type
`CREATED`	`string`
`DELETED`	`string`
`UPDATED`	`string`

Defined in

medusa/src/services/sales-channel.ts:24

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

addProducts

▸ addProducts(salesChannelId, productIds): Promise<SalesChannel>

Add a batch of product to a sales channel

Parameters

Name	Type	Description
`salesChannelId`	`string`	The id of the sales channel on which to add the products
`productIds`	`string`[]	The products ids to attach to the sales channel

Returns

Promise<SalesChannel>

the sales channel on which the products have been added

Defined in

medusa/src/services/sales-channel.ts:332

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
`TResult`
`TError`

Parameters

Name	Type	Description
`work`	(`transactionManager`: `EntityManager`) => `Promise`<`TResult`>	the transactional work to be done
`isolationOrErrorHandler?`	`IsolationLevel` \| (`error`: `TError`) => `Promise`<`void` \| `TResult`>	the isolation level to be used for the work.
`maybeErrorHandlerOrDontFail?`	(`error`: `TError`) => `Promise`<`void` \| `TResult`>	Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

create

▸ create(data): Promise<SalesChannel>

Creates a SalesChannel

This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project.

Parameters

Name	Type
`data`	`CreateSalesChannelInput`

Returns

Promise<SalesChannel>

the created channel

Defined in

medusa/src/services/sales-channel.ts:168

createDefault

▸ createDefault(): Promise<SalesChannel>

Creates a default sales channel, if this does not already exist.

Returns

Promise<SalesChannel>

the sales channel

Defined in

medusa/src/services/sales-channel.ts:258

delete

▸ delete(salesChannelId): Promise<void>

Deletes a sales channel from This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project.

Parameters

Name	Type	Description
`salesChannelId`	`string`	the id of the sales channel to delete

Returns

Promise<void>

Defined in

medusa/src/services/sales-channel.ts:219

listAndCount

▸ listAndCount(selector, config?): Promise<[SalesChannel[], number]>

Lists sales channels based on the provided parameters and includes the count of sales channels that match the query.

Parameters

Name	Type
`selector`	`QuerySelector`<`SalesChannel`>
`config`	`FindConfig`<`SalesChannel`>

Returns

Promise<[SalesChannel[], number]>

an array containing the sales channels as the first element and the total count of sales channels that matches the query as the second element.

Defined in

medusa/src/services/sales-channel.ts:134

removeProducts

▸ removeProducts(salesChannelId, productIds): Promise<SalesChannel>

Remove a batch of product from a sales channel

Parameters

Name	Type	Description
`salesChannelId`	`string`	The id of the sales channel on which to remove the products
`productIds`	`string`[]	The products ids to remove from the sales channel

Returns

Promise<SalesChannel>

the sales channel on which the products have been removed

Defined in

medusa/src/services/sales-channel.ts:311

retrieve

▸ retrieve(salesChannelId, config?): Promise<SalesChannel>

Retrieve a SalesChannel by id

Parameters

Name	Type	Description
`salesChannelId`	`string`	id of the channel to retrieve
`config`	`FindConfig`<`SalesChannel`>	SC config This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project.

Returns

Promise<SalesChannel>

a sales channel

Defined in

medusa/src/services/sales-channel.ts:92

retrieveByName

▸ retrieveByName(name, config?): Promise<unknown>

Find a sales channel by name.

Parameters

Name	Type	Description
`name`	`string`	of the sales channel
`config`	`FindConfig`<`SalesChannel`>	find config

Returns

Promise<unknown>

a sales channel with matching name

Defined in

medusa/src/services/sales-channel.ts:113

retrieveDefault

▸ retrieveDefault(): Promise<SalesChannel>

Retrieves the default sales channel.

Returns

Promise<SalesChannel>

the sales channel

Defined in

medusa/src/services/sales-channel.ts:288

retrieve_

▸ Protected retrieve_(selector, config?): Promise<SalesChannel>

A generic retrieve used to find a sales channel by different attributes.

Parameters

Name	Type	Description
`selector`	`Selector`<`SalesChannel`>	SC selector
`config`	`FindConfig`<`SalesChannel`>	find config

Returns

Promise<SalesChannel>

a single SC matching the query or throws

Defined in

medusa/src/services/sales-channel.ts:54

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
`err`	`Record`<`string`, `unknown`> \| { `code`: `string` }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

update

▸ update(salesChannelId, data): Promise<SalesChannel>

Parameters

Name	Type
`salesChannelId`	`string`
`data`	`Partial`<`CreateSalesChannelInput`>

Returns

Promise<SalesChannel>

Defined in

medusa/src/services/sales-channel.ts:185

withTransaction

▸ withTransaction(transactionManager?): SalesChannelService

Parameters

Name	Type
`transactionManager?`	`EntityManager`

Returns

SalesChannelService

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20

12 KiB Raw Blame History

Class: SalesChannelService

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

__configModule__

Inherited from

Defined in

__container__

Inherited from

Defined in

__moduleDeclaration__

Inherited from

Defined in

eventBusService_

Defined in

manager_

Inherited from

Defined in

salesChannelRepository_

Defined in

storeService_

Defined in

transactionManager_

Inherited from

Defined in

Events

Type declaration

Defined in

Accessors

activeManager_

Returns

Inherited from

Defined in

Methods

addProducts

Parameters

Returns

Defined in

atomicPhase_

Type parameters

Parameters

Returns

Inherited from

Defined in

create

Parameters

Returns

Defined in

createDefault

Returns

Defined in

delete

Parameters

Returns

Defined in

listAndCount

Parameters

Returns

Defined in

removeProducts

Parameters

Returns

Defined in

retrieve

Parameters

Returns

Defined in

retrieveByName

Parameters

Returns

Defined in

retrieveDefault

Returns

Defined in

retrieve_

12 KiB

Raw Blame History

configModule

container

moduleDeclaration