@apideck/node
Version:
Apideck Node.js SDK
627 lines (526 loc) • 18.2 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* Apideck
* The Apideck OpenAPI Spec: SDK Optimized
*
* The version of the OpenAPI document: 10.13.0
* Contact: support@apideck.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import {
EcommerceCustomersFilter,
EcommerceOrdersFilter,
GetEcommerceCustomerResponse,
GetEcommerceCustomerResponseFromJSON,
GetEcommerceCustomersResponse,
GetEcommerceCustomersResponseFromJSON,
GetEcommerceOrderResponse,
GetEcommerceOrderResponseFromJSON,
GetEcommerceOrdersResponse,
GetEcommerceOrdersResponseFromJSON,
GetProductResponse,
GetProductResponseFromJSON,
GetProductsResponse,
GetProductsResponseFromJSON,
GetStoreResponse,
GetStoreResponseFromJSON,
OrdersSort,
PassThroughQuery
} from '../models'
import * as runtime from '../runtime'
export interface EcommerceApiCustomersAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: EcommerceCustomersFilter
passThrough?: PassThroughQuery
fields?: string | null
}
export interface EcommerceApiCustomersOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface EcommerceApiOrdersAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
filter?: EcommerceOrdersFilter
sort?: OrdersSort
passThrough?: PassThroughQuery
fields?: string | null
}
export interface EcommerceApiOrdersOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface EcommerceApiProductsAllRequest {
raw?: boolean
consumerId?: string
appId?: string
serviceId?: string
cursor?: string | null
limit?: number
passThrough?: PassThroughQuery
fields?: string | null
}
export interface EcommerceApiProductsOneRequest {
id: string
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
export interface EcommerceApiStoresOneRequest {
consumerId?: string
appId?: string
serviceId?: string
raw?: boolean
fields?: string | null
}
/**
*
*/
export class EcommerceApi extends runtime.BaseAPI {
/**
* List Customers
* List Customers
*/
async customersAllRaw(
requestParameters: EcommerceApiCustomersAllRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetEcommerceCustomersResponse>> {
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.cursor !== undefined) {
queryParameters['cursor'] = requestParameters.cursor
}
if (requestParameters.limit !== undefined) {
queryParameters['limit'] = requestParameters.limit
}
if (requestParameters.filter !== undefined) {
queryParameters['filter'] = requestParameters.filter
}
if (requestParameters.passThrough !== undefined) {
queryParameters['pass_through'] = requestParameters.passThrough
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/ecommerce/customers`,
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetEcommerceCustomersResponseFromJSON(jsonValue)
)
}
/**
* List Customers
* List Customers
*/
async customersAll(
requestParameters: EcommerceApiCustomersAllRequest = {},
initOverrides?: RequestInit
): Promise<GetEcommerceCustomersResponse> {
const response = await this.customersAllRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get Customer
* Get Customer
*/
async customersOneRaw(
requestParameters: EcommerceApiCustomersOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetEcommerceCustomerResponse>> {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling customersOne.'
)
}
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/ecommerce/customers/{id}`.replace(
`{${'id'}}`,
encodeURIComponent(String(requestParameters.id))
),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetEcommerceCustomerResponseFromJSON(jsonValue)
)
}
/**
* Get Customer
* Get Customer
*/
async customersOne(
requestParameters: EcommerceApiCustomersOneRequest,
initOverrides?: RequestInit
): Promise<GetEcommerceCustomerResponse> {
const response = await this.customersOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* List Orders
* List Orders
*/
async ordersAllRaw(
requestParameters: EcommerceApiOrdersAllRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetEcommerceOrdersResponse>> {
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.cursor !== undefined) {
queryParameters['cursor'] = requestParameters.cursor
}
if (requestParameters.limit !== undefined) {
queryParameters['limit'] = requestParameters.limit
}
if (requestParameters.filter !== undefined) {
queryParameters['filter'] = requestParameters.filter
}
if (requestParameters.sort !== undefined) {
queryParameters['sort'] = requestParameters.sort
}
if (requestParameters.passThrough !== undefined) {
queryParameters['pass_through'] = requestParameters.passThrough
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/ecommerce/orders`,
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetEcommerceOrdersResponseFromJSON(jsonValue)
)
}
/**
* List Orders
* List Orders
*/
async ordersAll(
requestParameters: EcommerceApiOrdersAllRequest = {},
initOverrides?: RequestInit
): Promise<GetEcommerceOrdersResponse> {
const response = await this.ordersAllRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get Order
* Get Order
*/
async ordersOneRaw(
requestParameters: EcommerceApiOrdersOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetEcommerceOrderResponse>> {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling ordersOne.'
)
}
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/ecommerce/orders/{id}`.replace(
`{${'id'}}`,
encodeURIComponent(String(requestParameters.id))
),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetEcommerceOrderResponseFromJSON(jsonValue)
)
}
/**
* Get Order
* Get Order
*/
async ordersOne(
requestParameters: EcommerceApiOrdersOneRequest,
initOverrides?: RequestInit
): Promise<GetEcommerceOrderResponse> {
const response = await this.ordersOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* List Products
* List Products
*/
async productsAllRaw(
requestParameters: EcommerceApiProductsAllRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetProductsResponse>> {
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.cursor !== undefined) {
queryParameters['cursor'] = requestParameters.cursor
}
if (requestParameters.limit !== undefined) {
queryParameters['limit'] = requestParameters.limit
}
if (requestParameters.passThrough !== undefined) {
queryParameters['pass_through'] = requestParameters.passThrough
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/ecommerce/products`,
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue =>
GetProductsResponseFromJSON(jsonValue)
)
}
/**
* List Products
* List Products
*/
async productsAll(
requestParameters: EcommerceApiProductsAllRequest = {},
initOverrides?: RequestInit
): Promise<GetProductsResponse> {
const response = await this.productsAllRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get Product
* Get Product
*/
async productsOneRaw(
requestParameters: EcommerceApiProductsOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetProductResponse>> {
if (requestParameters.id === null || requestParameters.id === undefined) {
throw new runtime.RequiredError(
'id',
'Required parameter requestParameters.id was null or undefined when calling productsOne.'
)
}
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/ecommerce/products/{id}`.replace(
`{${'id'}}`,
encodeURIComponent(String(requestParameters.id))
),
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue => GetProductResponseFromJSON(jsonValue))
}
/**
* Get Product
* Get Product
*/
async productsOne(
requestParameters: EcommerceApiProductsOneRequest,
initOverrides?: RequestInit
): Promise<GetProductResponse> {
const response = await this.productsOneRaw(requestParameters, initOverrides)
return await response.value()
}
/**
* Get Store
* Get Store
*/
async storesOneRaw(
requestParameters: EcommerceApiStoresOneRequest,
initOverrides?: RequestInit
): Promise<runtime.ApiResponse<GetStoreResponse>> {
const queryParameters: any = {}
if (requestParameters.raw !== undefined) {
queryParameters['raw'] = requestParameters.raw
}
if (requestParameters.fields !== undefined) {
queryParameters['fields'] = requestParameters.fields
}
const headerParameters: runtime.HTTPHeaders = {}
if (requestParameters.consumerId !== undefined && requestParameters.consumerId !== null) {
headerParameters['x-apideck-consumer-id'] = String(requestParameters.consumerId)
}
if (requestParameters.appId !== undefined && requestParameters.appId !== null) {
headerParameters['x-apideck-app-id'] = String(requestParameters.appId)
}
if (requestParameters.serviceId !== undefined && requestParameters.serviceId !== null) {
headerParameters['x-apideck-service-id'] = String(requestParameters.serviceId)
}
if (this.configuration && this.configuration.apiKey) {
headerParameters['Authorization'] = this.configuration.apiKey('Authorization') // apiKey authentication
}
const response = await this.request(
{
path: `/ecommerce/store`,
method: 'GET',
headers: headerParameters,
query: queryParameters
},
initOverrides
)
return new runtime.JSONApiResponse(response, jsonValue => GetStoreResponseFromJSON(jsonValue))
}
/**
* Get Store
* Get Store
*/
async storesOne(
requestParameters: EcommerceApiStoresOneRequest = {},
initOverrides?: RequestInit
): Promise<GetStoreResponse> {
const response = await this.storesOneRaw(requestParameters, initOverrides)
return await response.value()
}
}