Class MessagesApi

Hierarchy

BaseAPI
- MessagesApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new MessagesApi(configuration?: Configuration): MessagesApi

Inherited from runtime.BaseAPI.constructor
- Defined in runtime.ts:25
Parameters
- configuration: Configuration = ...
Returns MessagesApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from runtime.BaseAPI.request
- Defined in runtime.ts:47
Parameters
- context: RequestOpts
Returns Promise<Response>

v1createMessages

v1createMessages(requestParameters: V1createMessagesRequest): Promise<InlineResponse2006>

- Defined in apis/MessagesApi.ts:73
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Send a message to a list of driver ids. Send a message to a list of driver ids.

Parameters
- requestParameters: V1createMessagesRequest
Returns Promise<InlineResponse2006>

v1createMessagesRaw

v1createMessagesRaw(requestParameters: V1createMessagesRequest): Promise<ApiResponse<InlineResponse2006>>

- Defined in apis/MessagesApi.ts:47
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Send a message to a list of driver ids. Send a message to a list of driver ids.

Parameters
- requestParameters: V1createMessagesRequest
Returns Promise<ApiResponse<InlineResponse2006>>

v1getMessages

v1getMessages(requestParameters: V1getMessagesRequest): Promise<InlineResponse2005>

- Defined in apis/MessagesApi.ts:109
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get all messages. Get all messages.

Parameters
- requestParameters: V1getMessagesRequest
Returns Promise<InlineResponse2005>

v1getMessagesRaw

v1getMessagesRaw(requestParameters: V1getMessagesRequest): Promise<ApiResponse<InlineResponse2005>>

- Defined in apis/MessagesApi.ts:82
<n class="warning"> <i class="fa fa-exclamation-circle"> This endpoint is still on our legacy API. Get all messages. Get all messages.

Parameters
- requestParameters: V1getMessagesRequest
Returns Promise<ApiResponse<InlineResponse2005>>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

Inherited from runtime.BaseAPI.withMiddleware
- Defined in runtime.ts:31
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T

Inherited from runtime.BaseAPI.withPostMiddleware
- Defined in runtime.ts:42
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T

Inherited from runtime.BaseAPI.withPreMiddleware
- Defined in runtime.ts:37
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Generated using TypeDoc