PartnerApi

All URIs are relative to http://localhost:8000/api

Method HTTP request Description
partnerDestroy DELETE /partner/{partner} Remove the specified resource from storage
partnerIndex GET /partner Display a listing of the resource
partnerShow GET /partner/{partner} Display the specified resource
partnerStore POST /partner Store a newly created resource in storage
partnerUpdate PUT /partner/{partner} Update the specified resource in storage

partnerDestroy

partnerDestroy()

Example

import {
    PartnerApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new PartnerApi(configuration);

let partner: string; //The partner ID (default to undefined)

const { status, data } = await apiInstance.partnerDestroy(
    partner
);

Parameters

Name Type Description Notes
partner [string] The partner ID defaults to undefined

Return type

void (empty response body)

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |204 | No content | - | |404 | Not found | - | |401 | Unauthenticated | - |

Back to top Back to API list Back to Model list Back to README

partnerIndex

PartnerIndex200Response partnerIndex()

Example

import {
    PartnerApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new PartnerApi(configuration);

const { status, data } = await apiInstance.partnerIndex();

Parameters

This endpoint does not have any parameters.

Return type

PartnerIndex200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | Array of `PartnerResource` | - | |401 | Unauthenticated | - |

Back to top Back to API list Back to Model list Back to README

partnerShow

PartnerStore200Response partnerShow()

Example

import {
    PartnerApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new PartnerApi(configuration);

let partner: string; //The partner ID (default to undefined)

const { status, data } = await apiInstance.partnerShow(
    partner
);

Parameters

Name Type Description Notes
partner [string] The partner ID defaults to undefined

Return type

PartnerStore200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `PartnerResource` | - | |404 | Not found | - | |401 | Unauthenticated | - |

Back to top Back to API list Back to Model list Back to README

partnerStore

PartnerStore200Response partnerStore(partnerStoreRequest)

Example

import {
    PartnerApi,
    Configuration,
    PartnerStoreRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new PartnerApi(configuration);

let partnerStoreRequest: PartnerStoreRequest; //

const { status, data } = await apiInstance.partnerStore(
    partnerStoreRequest
);

Parameters

Name Type Description Notes
partnerStoreRequest PartnerStoreRequest    

Return type

PartnerStore200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `PartnerResource` | - | |422 | Validation error | - | |401 | Unauthenticated | - |

Back to top Back to API list Back to Model list Back to README

partnerUpdate

PartnerStore200Response partnerUpdate(partnerStoreRequest)

Example

import {
    PartnerApi,
    Configuration,
    PartnerStoreRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new PartnerApi(configuration);

let partner: string; //The partner ID (default to undefined)
let partnerStoreRequest: PartnerStoreRequest; //

const { status, data } = await apiInstance.partnerUpdate(
    partner,
    partnerStoreRequest
);

Parameters

Name Type Description Notes
partnerStoreRequest PartnerStoreRequest    
partner [string] The partner ID defaults to undefined

Return type

PartnerStore200Response

Authorization

http

HTTP request headers

HTTP response details

| Status code | Description | Response headers | |————-|————-|——————| |200 | `PartnerResource` | - | |422 | Validation error | - | |404 | Not found | - | |401 | Unauthenticated | - |

Back to top Back to API list Back to Model list Back to README

This documentation was automatically generated from the TypeScript API client.