Reference

BackstageClient.refundPolicies

BackstageClient.refundPolicies in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / refundPolicies

refundPolicies: {
  listPolicies: (requestOptions?: RequestOptions) => Promise<{
     accountId: string | null;
     autoApprove: boolean;
     createdAt: string;
     customerMessage: string | null;
     eventId: string | null;
     exchangesEnabled: boolean;
     exchangeWindowHours: number | null;
     id: string;
     organisationId: string;
     refundsEnabled: boolean;
     refundWindowHours: number | null;
     retainFees: boolean;
     updatedAt: string;
  }[]>;
  upsertPolicy: (request: {
     accountId?: string;
     autoApprove?: boolean;
     customerMessage?: any;
     eventId?: string;
     exchangesEnabled?: boolean;
     exchangeWindowHours?: any;
     refundsEnabled?: boolean;
     refundWindowHours?: any;
     retainFees?: boolean;
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string | null;
     autoApprove: boolean;
     createdAt: string;
     customerMessage: string | null;
     eventId: string | null;
     exchangesEnabled: boolean;
     exchangeWindowHours: number | null;
     id: string;
     organisationId: string;
     refundsEnabled: boolean;
     refundWindowHours: number | null;
     retainFees: boolean;
     updatedAt: string;
  }>;
};

Defined in: client.ts:5004

Refund Policies methods

listPolicies()#

listPolicies: (requestOptions?: RequestOptions) => Promise<{
  accountId: string | null;
  autoApprove: boolean;
  createdAt: string;
  customerMessage: string | null;
  eventId: string | null;
  exchangesEnabled: boolean;
  exchangeWindowHours: number | null;
  id: string;
  organisationId: string;
  refundsEnabled: boolean;
  refundWindowHours: number | null;
  retainFees: boolean;
  updatedAt: string;
}[]>;

List refund policies Lists the refund and exchange policies configured for the organisation, at organisation, account and event scope.

Parameters#

Parameter	Type
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ accountId: string | null; autoApprove: boolean; createdAt: string; customerMessage: string | null; eventId: string | null; exchangesEnabled: boolean; exchangeWindowHours: number | null; id: string; organisationId: string; refundsEnabled: boolean; refundWindowHours: number | null; retainFees: boolean; updatedAt: string; }[]>

Operation Id#

listRefundPolicies

upsertPolicy()#

upsertPolicy: (request: {
  accountId?: string;
  autoApprove?: boolean;
  customerMessage?: any;
  eventId?: string;
  exchangesEnabled?: boolean;
  exchangeWindowHours?: any;
  refundsEnabled?: boolean;
  refundWindowHours?: any;
  retainFees?: boolean;
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string | null;
  autoApprove: boolean;
  createdAt: string;
  customerMessage: string | null;
  eventId: string | null;
  exchangesEnabled: boolean;
  exchangeWindowHours: number | null;
  id: string;
  organisationId: string;
  refundsEnabled: boolean;
  refundWindowHours: number | null;
  retainFees: boolean;
  updatedAt: string;
}>;

Create or update a refund policy Creates or replaces the refund and exchange policy for a scope. A policy is scoped to an account or to an event, never both; with neither it is the organisation default.

Parameters#

Parameter	Type
`request`	{ `accountId?`: `string`; `autoApprove?`: `boolean`; `customerMessage?`: `any`; `eventId?`: `string`; `exchangesEnabled?`: `boolean`; `exchangeWindowHours?`: `any`; `refundsEnabled?`: `boolean`; `refundWindowHours?`: `any`; `retainFees?`: `boolean`; }
`request.accountId?`	`string`
`request.autoApprove?`	`boolean`
`request.customerMessage?`	`any`
`request.eventId?`	`string`
`request.exchangesEnabled?`	`boolean`
`request.exchangeWindowHours?`	`any`
`request.refundsEnabled?`	`boolean`
`request.refundWindowHours?`	`any`
`request.retainFees?`	`boolean`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

upsertRefundPolicy