Class BOMApi

Hierarchy (View Summary)

BaseAPI
- BOMApi

Constructors

constructor

new BOMApi(configuration?: Configuration): BOMApi
Parameters
- configuration: Configuration = DefaultConfig
Returns BOMApi
Inherited from BaseAPI.constructor
- Defined in switcloud-api/generated/runtime.ts:97

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

createMerchant

createMerchant(
requestParameters: CreateMerchantRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<MerchantReadSchema>
Create Merchant
Parameters
- requestParameters: CreateMerchantRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<MerchantReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:213

createMerchantRaw

createMerchantRaw(
requestParameters: CreateMerchantRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<MerchantReadSchema>>
Create Merchant
Parameters
- requestParameters: CreateMerchantRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<MerchantReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:177

createPoi

createPoi(
requestParameters: CreatePoiRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<POIReadSchema>
Create Poi
Parameters
- requestParameters: CreatePoiRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<POIReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:257

createPoiRaw

createPoiRaw(
requestParameters: CreatePoiRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<POIReadSchema>>
Create Poi
Parameters
- requestParameters: CreatePoiRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<POIReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:221

createStore

createStore(
requestParameters: CreateStoreRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<StoreReadSchema>
Create Store
Parameters
- requestParameters: CreateStoreRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<StoreReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:301

createStoreRaw

createStoreRaw(
requestParameters: CreateStoreRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<StoreReadSchema>>
Create Store
Parameters
- requestParameters: CreateStoreRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<StoreReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:265

deleteMerchant

deleteMerchant(
requestParameters: DeleteMerchantRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<void>
Delete Merchant
Parameters
- requestParameters: DeleteMerchantRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in switcloud-api/generated/apis/BOMApi.ts:343

deleteMerchantRaw

deleteMerchantRaw(
requestParameters: DeleteMerchantRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<void>>
Delete Merchant
Parameters
- requestParameters: DeleteMerchantRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:309

deletePoi

deletePoi(
requestParameters: DeletePoiRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<void>
Delete Poi
Parameters
- requestParameters: DeletePoiRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in switcloud-api/generated/apis/BOMApi.ts:384

deletePoiRaw

deletePoiRaw(
requestParameters: DeletePoiRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<void>>
Delete Poi
Parameters
- requestParameters: DeletePoiRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:350

deleteStore

deleteStore(
requestParameters: DeleteStoreRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<void>
Delete Store
Parameters
- requestParameters: DeleteStoreRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in switcloud-api/generated/apis/BOMApi.ts:425

deleteStoreRaw

deleteStoreRaw(
requestParameters: DeleteStoreRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<void>>
Delete Store
Parameters
- requestParameters: DeleteStoreRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:391

getMerchant

getMerchant(
requestParameters: GetMerchantRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<MerchantReadSchema>
Get Merchant
Parameters
- requestParameters: GetMerchantRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<MerchantReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:466

getMerchantRaw

getMerchantRaw(
requestParameters: GetMerchantRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<MerchantReadSchema>>
Get Merchant
Parameters
- requestParameters: GetMerchantRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<MerchantReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:432

getPoi

getPoi(
requestParameters: GetPoiRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<POIReadSchema>
Get Poi
Parameters
- requestParameters: GetPoiRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<POIReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:508

getPoiRaw

getPoiRaw(
requestParameters: GetPoiRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<POIReadSchema>>
Get Poi
Parameters
- requestParameters: GetPoiRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<POIReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:474

getStore

getStore(
requestParameters: GetStoreRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<StoreReadSchema>
Get Store
Parameters
- requestParameters: GetStoreRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<StoreReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:550

getStoreRaw

getStoreRaw(
requestParameters: GetStoreRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<StoreReadSchema>>
Get Store
Parameters
- requestParameters: GetStoreRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<StoreReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:516

`Protected`isJsonMime

isJsonMime(mime: string): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in switcloud-api/generated/runtime.ts:127

listMerchants

listMerchants(
requestParameters?: ListMerchantsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<PageTypeVarCustomizedMerchantReadSchema>
List Merchants
Parameters
- requestParameters: ListMerchantsRequest = {}
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<PageTypeVarCustomizedMerchantReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:604

listMerchantsRaw

listMerchantsRaw(
requestParameters: ListMerchantsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<PageTypeVarCustomizedMerchantReadSchema>>
List Merchants
Parameters
- requestParameters: ListMerchantsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<PageTypeVarCustomizedMerchantReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:558

listPois

listPois(
requestParameters?: ListPoisRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<PageTypeVarCustomizedPOIReadSchema>
List Pois
Parameters
- requestParameters: ListPoisRequest = {}
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<PageTypeVarCustomizedPOIReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:670

listPoisRaw

listPoisRaw(
requestParameters: ListPoisRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<PageTypeVarCustomizedPOIReadSchema>>
List Pois
Parameters
- requestParameters: ListPoisRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<PageTypeVarCustomizedPOIReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:612

listStores

listStores(
requestParameters?: ListStoresRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<PageTypeVarCustomizedStoreReadSchema>
List Stores
Parameters
- requestParameters: ListStoresRequest = {}
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<PageTypeVarCustomizedStoreReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:724

listStoresRaw

listStoresRaw(
requestParameters: ListStoresRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<PageTypeVarCustomizedStoreReadSchema>>
List Stores
Parameters
- requestParameters: ListStoresRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<PageTypeVarCustomizedStoreReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:678

partialUpdateMerchant

partialUpdateMerchant(
requestParameters: PartialUpdateMerchantRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<MerchantReadSchema>
Partial Update Merchant
Parameters
- requestParameters: PartialUpdateMerchantRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<MerchantReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:776

partialUpdateMerchantRaw

partialUpdateMerchantRaw(
requestParameters: PartialUpdateMerchantRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<MerchantReadSchema>>
Partial Update Merchant
Parameters
- requestParameters: PartialUpdateMerchantRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<MerchantReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:732

partialUpdatePoi

partialUpdatePoi(
requestParameters: PartialUpdatePoiRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<POIReadSchema>
Partial Update Poi
Parameters
- requestParameters: PartialUpdatePoiRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<POIReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:828

partialUpdatePoiRaw

partialUpdatePoiRaw(
requestParameters: PartialUpdatePoiRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<POIReadSchema>>
Partial Update Poi
Parameters
- requestParameters: PartialUpdatePoiRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<POIReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:784

partialUpdateStore

partialUpdateStore(
requestParameters: PartialUpdateStoreRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<StoreReadSchema>
Partial Update Store
Parameters
- requestParameters: PartialUpdateStoreRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<StoreReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:880

partialUpdateStoreRaw

partialUpdateStoreRaw(
requestParameters: PartialUpdateStoreRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<StoreReadSchema>>
Partial Update Store
Parameters
- requestParameters: PartialUpdateStoreRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<StoreReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:836

`Protected`request

request(
context: RequestOpts,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<Response>
Parameters
- context: RequestOpts
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in switcloud-api/generated/runtime.ts:134

updateMerchant

updateMerchant(
requestParameters: UpdateMerchantRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<MerchantReadSchema>
Update Merchant
Parameters
- requestParameters: UpdateMerchantRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<MerchantReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:932

updateMerchantRaw

updateMerchantRaw(
requestParameters: UpdateMerchantRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<MerchantReadSchema>>
Update Merchant
Parameters
- requestParameters: UpdateMerchantRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<MerchantReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:888

updatePoi

updatePoi(
requestParameters: UpdatePoiRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<POIReadSchema>
Update Poi
Parameters
- requestParameters: UpdatePoiRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<POIReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:984

updatePoiRaw

updatePoiRaw(
requestParameters: UpdatePoiRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<POIReadSchema>>
Update Poi
Parameters
- requestParameters: UpdatePoiRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<POIReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:940

updateStore

updateStore(
requestParameters: UpdateStoreRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<StoreReadSchema>
Update Store
Parameters
- requestParameters: UpdateStoreRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<StoreReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1036

updateStoreRaw

updateStoreRaw(
requestParameters: UpdateStoreRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<StoreReadSchema>>
Update Store
Parameters
- requestParameters: UpdateStoreRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<StoreReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:992

withMiddleware

withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in switcloud-api/generated/runtime.ts:101

withPostMiddleware

withPostMiddleware<T extends BaseAPI>(
    this: T,
    ...postMiddlewares: (
        (context: ResponseContext) => Promise<void | Response>
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in switcloud-api/generated/runtime.ts:112

withPreMiddleware

withPreMiddleware<T extends BaseAPI>(
    this: T,
    ...preMiddlewares: (
        (context: RequestContext) => Promise<void | FetchParams>
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in switcloud-api/generated/runtime.ts:107