IntegrationPartners | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- IntegrationPartners

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IntegrationPartners(options: IntegrationPartnersOptions, http: Client): IntegrationPartners

Overrides ThBaseHandler.constructor
- Defined in src/v0/integration_partners.ts:53
Parameters
- options: IntegrationPartnersOptions
- http: Client
Returns IntegrationPartners

Properties

endpoint

endpoint: string

http

http: Client

options

options: IntegrationPartnersOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/integration-partners'

Methods

create

create(body: IntegrationPartnerCreateBody): Promise<IntegrationPartnerResponse>

- Defined in src/v0/integration_partners.ts:161
Parameters
- body: IntegrationPartnerCreateBody
Returns Promise<IntegrationPartnerResponse>

delete

delete(integrationPartnerId: string): Promise<IntegrationPartnerResponse>

- Defined in src/v0/integration_partners.ts:216
Parameters
- integrationPartnerId: string
Returns Promise<IntegrationPartnerResponse>

get

get(integrationPartnerId: string): Promise<IntegrationPartnerResponse>

- Defined in src/v0/integration_partners.ts:135
Parameters
- integrationPartnerId: string
Returns Promise<IntegrationPartnerResponse>

getAll

getAll(query?: IntegrationPartnersQuery): Promise<IntegrationPartnersListResponse>

- Defined in src/v0/integration_partners.ts:81
Parameters
- Optional query: IntegrationPartnersQuery
Returns Promise<IntegrationPartnersListResponse>

listAll

listAll(query?: Pick<IntegrationPartnersQuery, "withDeleted">): Promise<IntegrationPartner[]>

- Defined in src/v0/integration_partners.ts:117
Parameters
- Optional query: Pick<IntegrationPartnersQuery, "withDeleted">
Returns Promise<IntegrationPartner[]>

Private partnerPath

partnerPath(integrationPartnerId: string): string

- Defined in src/v0/integration_partners.ts:70
Parameters
- integrationPartnerId: string
Returns string

restore

restore(integrationPartnerId: string): Promise<IntegrationPartnerResponse>

- Defined in src/v0/integration_partners.ts:242
Parameters
- integrationPartnerId: string
Returns Promise<IntegrationPartnerResponse>

update

update(integrationPartnerId: string, body: IntegrationPartnerUpdateBody): Promise<IntegrationPartnerResponse>

- Defined in src/v0/integration_partners.ts:187
Parameters
- integrationPartnerId: string
- body: IntegrationPartnerUpdateBody
Returns Promise<IntegrationPartnerResponse>

Generated using TypeDoc