Class BOMApi

Hierarchy (View Summary)

BaseAPI
- BOMApi

Index

Constructors

Properties

Methods

createContract createContractRaw createMerchant createMerchantRaw createPoi createPoiRaw createService createServiceRaw createStore createStoreRaw deleteContract deleteContractRaw deleteMerchant deleteMerchantRaw deletePoi deletePoiRaw deleteService deleteServiceRaw deleteStore deleteStoreRaw getContract getContractRaw getMerchant getMerchantRaw getMyOrganization getMyOrganizationRaw getPoi getPoiRaw getService getServiceRaw getStore getStoreRaw isJsonMime listContracts listContractsRaw listMerchants listMerchantsRaw listPois listPoisRaw listServices listServicesRaw listStores listStoresRaw partialUpdateContract partialUpdateContractRaw partialUpdateMerchant partialUpdateMerchantRaw partialUpdateMyOrganization partialUpdateMyOrganizationRaw partialUpdatePoi partialUpdatePoiRaw partialUpdateService partialUpdateServiceRaw partialUpdateStore partialUpdateStoreRaw request updateContract updateContractRaw updateMerchant updateMerchantRaw updateMyOrganization updateMyOrganizationRaw updatePoi updatePoiRaw updateService updateServiceRaw updateStore updateStoreRaw withMiddleware withPostMiddleware withPreMiddleware

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

createContract

createContract(
requestParameters: CreateContractRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ContractReadSchema>
Create Contract
Parameters
- requestParameters: CreateContractRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ContractReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:320

createContractRaw

createContractRaw(
requestParameters: CreateContractRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<ContractReadSchema>>
Create Contract
Parameters
- requestParameters: CreateContractRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<ContractReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:287

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:361

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:328

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:402

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:369

createService

createService(
requestParameters: CreateServiceRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ServiceReadSchema>
Create Service
Parameters
- requestParameters: CreateServiceRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ServiceReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:443

createServiceRaw

createServiceRaw(
requestParameters: CreateServiceRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<ServiceReadSchema>>
Create Service
Parameters
- requestParameters: CreateServiceRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<ServiceReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:410

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:484

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:451

deleteContract

deleteContract(
requestParameters: DeleteContractRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<void>
Delete Contract
Parameters
- requestParameters: DeleteContractRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in switcloud-api/generated/apis/BOMApi.ts:522

deleteContractRaw

deleteContractRaw(
requestParameters: DeleteContractRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<void>>
Delete Contract
Parameters
- requestParameters: DeleteContractRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:492

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:559

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:529

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:596

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:566

deleteService

deleteService(
requestParameters: DeleteServiceRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<void>
Delete Service
Parameters
- requestParameters: DeleteServiceRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in switcloud-api/generated/apis/BOMApi.ts:633

deleteServiceRaw

deleteServiceRaw(
requestParameters: DeleteServiceRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<void>>
Delete Service
Parameters
- requestParameters: DeleteServiceRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:603

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:670

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:640

getContract

getContract(
requestParameters: GetContractRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ContractReadSchema>
Get Contract
Parameters
- requestParameters: GetContractRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ContractReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:707

getContractRaw

getContractRaw(
requestParameters: GetContractRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<ContractReadSchema>>
Get Contract
Parameters
- requestParameters: GetContractRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<ContractReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:677

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:745

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:715

getMyOrganization

getMyOrganization(
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<OrganizationReadSchema>
Get My Organization
Parameters
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<OrganizationReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:776

getMyOrganizationRaw

getMyOrganizationRaw(
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<OrganizationReadSchema>>
Get My Organization
Parameters
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<OrganizationReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:753

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:814

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:784

getService

getService(
requestParameters: GetServiceRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ServiceReadSchema>
Get Service
Parameters
- requestParameters: GetServiceRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ServiceReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:852

getServiceRaw

getServiceRaw(
requestParameters: GetServiceRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<ServiceReadSchema>>
Get Service
Parameters
- requestParameters: GetServiceRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<ServiceReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:822

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:890

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:860

`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

listContracts

listContracts(
requestParameters?: ListContractsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<PageTypeVarCustomizedContractReadSchema>
List Contracts
Parameters
- requestParameters: ListContractsRequest = {}
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<PageTypeVarCustomizedContractReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:941

listContractsRaw

listContractsRaw(
requestParameters: ListContractsRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<PageTypeVarCustomizedContractReadSchema>>
List Contracts
Parameters
- requestParameters: ListContractsRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<PageTypeVarCustomizedContractReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:898

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:992

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:949

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:1055

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:1000

listServices

listServices(
requestParameters?: ListServicesRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<PageTypeVarCustomizedServiceReadSchema>
List Services
Parameters
- requestParameters: ListServicesRequest = {}
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<PageTypeVarCustomizedServiceReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1106

listServicesRaw

listServicesRaw(
requestParameters: ListServicesRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<PageTypeVarCustomizedServiceReadSchema>>
List Services
Parameters
- requestParameters: ListServicesRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<PageTypeVarCustomizedServiceReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1063

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:1157

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:1114

partialUpdateContract

partialUpdateContract(
requestParameters: PartialUpdateContractRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ContractReadSchema>
Partial Update Contract
Parameters
- requestParameters: PartialUpdateContractRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ContractReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1205

partialUpdateContractRaw

partialUpdateContractRaw(
requestParameters: PartialUpdateContractRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<ContractReadSchema>>
Partial Update Contract
Parameters
- requestParameters: PartialUpdateContractRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<ContractReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1165

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:1253

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:1213

partialUpdateMyOrganization

partialUpdateMyOrganization(
requestParameters: PartialUpdateMyOrganizationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<OrganizationReadSchema>
Partial Update My Organization
Parameters
- requestParameters: PartialUpdateMyOrganizationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<OrganizationReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1294

partialUpdateMyOrganizationRaw

partialUpdateMyOrganizationRaw(
requestParameters: PartialUpdateMyOrganizationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<OrganizationReadSchema>>
Partial Update My Organization
Parameters
- requestParameters: PartialUpdateMyOrganizationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<OrganizationReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1261

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:1342

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:1302

partialUpdateService

partialUpdateService(
requestParameters: PartialUpdateServiceRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ServiceReadSchema>
Partial Update Service
Parameters
- requestParameters: PartialUpdateServiceRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ServiceReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1390

partialUpdateServiceRaw

partialUpdateServiceRaw(
requestParameters: PartialUpdateServiceRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<ServiceReadSchema>>
Partial Update Service
Parameters
- requestParameters: PartialUpdateServiceRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<ServiceReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1350

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:1438

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:1398

`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

updateContract

updateContract(
requestParameters: UpdateContractRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ContractReadSchema>
Update Contract
Parameters
- requestParameters: UpdateContractRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ContractReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1486

updateContractRaw

updateContractRaw(
requestParameters: UpdateContractRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<ContractReadSchema>>
Update Contract
Parameters
- requestParameters: UpdateContractRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<ContractReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1446

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:1534

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:1494

updateMyOrganization

updateMyOrganization(
requestParameters: UpdateMyOrganizationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<OrganizationReadSchema>
Update My Organization
Parameters
- requestParameters: UpdateMyOrganizationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<OrganizationReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1575

updateMyOrganizationRaw

updateMyOrganizationRaw(
requestParameters: UpdateMyOrganizationRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<OrganizationReadSchema>>
Update My Organization
Parameters
- requestParameters: UpdateMyOrganizationRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<OrganizationReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1542

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:1623

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:1583

updateService

updateService(
requestParameters: UpdateServiceRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ServiceReadSchema>
Update Service
Parameters
- requestParameters: UpdateServiceRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ServiceReadSchema>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1671

updateServiceRaw

updateServiceRaw(
requestParameters: UpdateServiceRequest,
initOverrides?: RequestInit | InitOverrideFunction,
): Promise<ApiResponse<ServiceReadSchema>>
Update Service
Parameters
- requestParameters: UpdateServiceRequest
- OptionalinitOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<ServiceReadSchema>>
- Defined in switcloud-api/generated/apis/BOMApi.ts:1631

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:1719

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:1679

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

Class BOMApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BOMApi

Properties

Protectedconfiguration

Methods

createContract

Parameters

Returns Promise<ContractReadSchema>

createContractRaw

Parameters

Returns Promise<ApiResponse<ContractReadSchema>>

createMerchant

Parameters

Returns Promise<MerchantReadSchema>

createMerchantRaw

Parameters

Returns Promise<ApiResponse<MerchantReadSchema>>

createPoi

Parameters

Returns Promise<POIReadSchema>

createPoiRaw

Parameters

Returns Promise<ApiResponse<POIReadSchema>>

createService

Parameters

Returns Promise<ServiceReadSchema>

createServiceRaw

Parameters

Returns Promise<ApiResponse<ServiceReadSchema>>

createStore

Parameters

Returns Promise<StoreReadSchema>

createStoreRaw

Parameters

Returns Promise<ApiResponse<StoreReadSchema>>

deleteContract

Parameters

Returns Promise<void>

deleteContractRaw

Parameters

Returns Promise<ApiResponse<void>>

deleteMerchant

Parameters

Returns Promise<void>

deleteMerchantRaw

Parameters

Returns Promise<ApiResponse<void>>

deletePoi

Parameters

Returns Promise<void>

deletePoiRaw

Parameters

Returns Promise<ApiResponse<void>>

deleteService

Parameters

Returns Promise<void>

deleteServiceRaw

Parameters

Returns Promise<ApiResponse<void>>

deleteStore

Parameters

Returns Promise<void>

deleteStoreRaw

Parameters

Returns Promise<ApiResponse<void>>

getContract

Parameters

Returns Promise<ContractReadSchema>

getContractRaw

Parameters

Returns Promise<ApiResponse<ContractReadSchema>>

getMerchant

`Protected`configuration

`Protected`isJsonMime