Class CarrierProposedAssignmentsApi

Hierarchy

BaseAPI
- CarrierProposedAssignmentsApi

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new CarrierProposedAssignmentsApi(configuration?: Configuration): CarrierProposedAssignmentsApi

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

Properties

Protected configuration

configuration: Configuration = ...

Methods

createCarrierProposedAssignment

createCarrierProposedAssignment(requestParameters: CreateCarrierProposedAssignmentOperationRequest): Promise<CarrierProposedAssignmentResponse>

- Defined in apis/CarrierProposedAssignmentsApi.ts:78
Creates a new assignment that a driver can later use. Each driver can only have one future assignment. Create an assignment

Parameters
- requestParameters: CreateCarrierProposedAssignmentOperationRequest
Returns Promise<CarrierProposedAssignmentResponse>

createCarrierProposedAssignmentRaw

createCarrierProposedAssignmentRaw(requestParameters: CreateCarrierProposedAssignmentOperationRequest): Promise<ApiResponse<CarrierProposedAssignmentResponse>>

- Defined in apis/CarrierProposedAssignmentsApi.ts:56
Creates a new assignment that a driver can later use. Each driver can only have one future assignment. Create an assignment

Parameters
- requestParameters: CreateCarrierProposedAssignmentOperationRequest
Returns Promise<ApiResponse<CarrierProposedAssignmentResponse>>

deleteCarrierProposedAssignment

deleteCarrierProposedAssignment(requestParameters: DeleteCarrierProposedAssignmentRequest): Promise<string>

- Defined in apis/CarrierProposedAssignmentsApi.ts:110
Permanently delete an assignment. You can only delete assignments that are not yet active. To override a currently active assignment, create a new empty one, instead. Delete an assignment

Parameters
- requestParameters: DeleteCarrierProposedAssignmentRequest
Returns Promise<string>

deleteCarrierProposedAssignmentRaw

deleteCarrierProposedAssignmentRaw(requestParameters: DeleteCarrierProposedAssignmentRequest): Promise<ApiResponse<string>>

- Defined in apis/CarrierProposedAssignmentsApi.ts:87
Permanently delete an assignment. You can only delete assignments that are not yet active. To override a currently active assignment, create a new empty one, instead. Delete an assignment

Parameters
- requestParameters: DeleteCarrierProposedAssignmentRequest
Returns Promise<ApiResponse<string>>

listCarrierProposedAssignments

listCarrierProposedAssignments(requestParameters: ListCarrierProposedAssignmentsRequest): Promise<ListCarrierProposedAssignmentResponse>

- Defined in apis/CarrierProposedAssignmentsApi.ts:154
Show the assignments that are active for drivers and that would currently be visible to them in the driver app. Retrieve assignments

Parameters
- requestParameters: ListCarrierProposedAssignmentsRequest
Returns Promise<ListCarrierProposedAssignmentResponse>

listCarrierProposedAssignmentsRaw

listCarrierProposedAssignmentsRaw(requestParameters: ListCarrierProposedAssignmentsRequest): Promise<ApiResponse<ListCarrierProposedAssignmentResponse>>

- Defined in apis/CarrierProposedAssignmentsApi.ts:119
Show the assignments that are active for drivers and that would currently be visible to them in the driver app. Retrieve assignments

Parameters
- requestParameters: ListCarrierProposedAssignmentsRequest
Returns Promise<ApiResponse<ListCarrierProposedAssignmentResponse>>

Protected request

request(context: RequestOpts): Promise<Response>

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

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