Class PinsApi

Hierarchy

BaseAPI
- PinsApi

Implements

PinsApiInterface

Index

Constructors

constructor

Properties

configuration

Methods

Constructors

constructor

new PinsApi(configuration?: Configuration): PinsApi

Inherited from BaseAPI.constructor
- Defined in dist.generated/runtime.d.ts:19
Parameters
- Optional configuration: Configuration
Returns PinsApi

Properties

Protected configuration

configuration: Configuration

Methods

pinsGet

pinsGet(requestParameters?: PinsGetRequest, initOverrides?: RequestInit): Promise<PinResults>

Implementation of PinsApiInterface.pinsGet
- Defined in dist.generated/apis/PinsApi.d.ts:138
List all the pin objects, matching optional filters; when no filter is provided, only successful pins are returned List pin objects

Parameters
- Optional requestParameters: PinsGetRequest
- Optional initOverrides: RequestInit
Returns Promise<PinResults>

pinsGetRaw

pinsGetRaw(requestParameters: PinsGetRequest, initOverrides?: RequestInit): Promise<ApiResponse<PinResults>>

Implementation of PinsApiInterface.pinsGetRaw
- Defined in dist.generated/apis/PinsApi.d.ts:133
List all the pin objects, matching optional filters; when no filter is provided, only successful pins are returned List pin objects

Parameters
- requestParameters: PinsGetRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PinResults>>

pinsPost

pinsPost(requestParameters: PinsPostRequest, initOverrides?: RequestInit): Promise<PinStatus>

Implementation of PinsApiInterface.pinsPost
- Defined in dist.generated/apis/PinsApi.d.ts:148
Add a new pin object for the current access token Add pin object

Parameters
- requestParameters: PinsPostRequest
- Optional initOverrides: RequestInit
Returns Promise<PinStatus>

pinsPostRaw

pinsPostRaw(requestParameters: PinsPostRequest, initOverrides?: RequestInit): Promise<ApiResponse<PinStatus>>

Implementation of PinsApiInterface.pinsPostRaw
- Defined in dist.generated/apis/PinsApi.d.ts:143
Add a new pin object for the current access token Add pin object

Parameters
- requestParameters: PinsPostRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PinStatus>>

pinsRequestidDelete

pinsRequestidDelete(requestParameters: PinsRequestidDeleteRequest, initOverrides?: RequestInit): Promise<void>

Implementation of PinsApiInterface.pinsRequestidDelete
- Defined in dist.generated/apis/PinsApi.d.ts:158
Remove a pin object Remove pin object

Parameters
- requestParameters: PinsRequestidDeleteRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

pinsRequestidDeleteRaw

pinsRequestidDeleteRaw(requestParameters: PinsRequestidDeleteRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>

Implementation of PinsApiInterface.pinsRequestidDeleteRaw
- Defined in dist.generated/apis/PinsApi.d.ts:153
Remove a pin object Remove pin object

Parameters
- requestParameters: PinsRequestidDeleteRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

pinsRequestidGet

pinsRequestidGet(requestParameters: PinsRequestidGetRequest, initOverrides?: RequestInit): Promise<PinStatus>

Implementation of PinsApiInterface.pinsRequestidGet
- Defined in dist.generated/apis/PinsApi.d.ts:168
Get a pin object and its status Get pin object

Parameters
- requestParameters: PinsRequestidGetRequest
- Optional initOverrides: RequestInit
Returns Promise<PinStatus>

pinsRequestidGetRaw

pinsRequestidGetRaw(requestParameters: PinsRequestidGetRequest, initOverrides?: RequestInit): Promise<ApiResponse<PinStatus>>

Implementation of PinsApiInterface.pinsRequestidGetRaw
- Defined in dist.generated/apis/PinsApi.d.ts:163
Get a pin object and its status Get pin object

Parameters
- requestParameters: PinsRequestidGetRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PinStatus>>

pinsRequestidPost

pinsRequestidPost(requestParameters: PinsRequestidPostRequest, initOverrides?: RequestInit): Promise<PinStatus>

Implementation of PinsApiInterface.pinsRequestidPost
- Defined in dist.generated/apis/PinsApi.d.ts:178
Replace an existing pin object (shortcut for executing remove and add operations in one step to avoid unnecessary garbage collection of blocks present in both recursive pins) Replace pin object

Parameters
- requestParameters: PinsRequestidPostRequest
- Optional initOverrides: RequestInit
Returns Promise<PinStatus>

pinsRequestidPostRaw

pinsRequestidPostRaw(requestParameters: PinsRequestidPostRequest, initOverrides?: RequestInit): Promise<ApiResponse<PinStatus>>

Implementation of PinsApiInterface.pinsRequestidPostRaw
- Defined in dist.generated/apis/PinsApi.d.ts:173
Replace an existing pin object (shortcut for executing remove and add operations in one step to avoid unnecessary garbage collection of blocks present in both recursive pins) Replace pin object

Parameters
- requestParameters: PinsRequestidPostRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PinStatus>>

Protected request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>

Inherited from BaseAPI.request
- Defined in dist.generated/runtime.d.ts:23
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

withMiddleware

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

Inherited from BaseAPI.withMiddleware
- Defined in dist.generated/runtime.d.ts:20
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

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

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

withPreMiddleware

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

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