Class MessageSenders

Hierarchy

MessageSenders

Index

Properties

Methods

As Create Delete DeleteAssignment Get List ListAssignments ListCCListenerAssignments Patch Save SaveAssignment SaveCCListenerAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

As(): MessageSenders
Description
enables impersonation by calling the subsequent method with the stored impersonation token

Example
```
MessageSenders.As().List() // lists MessageSenders using the impersonated users' token
```
Returns MessageSenders
- Defined in api/MessageSenders.ts:297

Create

Create<TMessageSender>(messageSender: MessageSender<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TMessageSender>>
Create a new message sender. If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned. Check out the docs for more info
Type Parameters
- TMessageSender extends MessageSender<any, TMessageSender>
Parameters
- messageSender: MessageSender<any>
  
  Required fields: Name, MessageTypes
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TMessageSender>>
- Defined in api/MessageSenders.ts:71

Delete

Delete(messageSenderID: string, requestOptions?: RequestOptions): Promise<void>
Delete a message sender. Check out the docs for more info
Parameters
- messageSenderID: string
  
  ID of the message sender.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/MessageSenders.ts:135

DeleteAssignment

DeleteAssignment(messageSenderID: string, listOptions?: {
    buyerID?: string;
    supplierID?: string;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<void>
Delete a message sender assignment. Check out the docs for more info
Parameters
- messageSenderID: string
  
  ID of the message sender.
- listOptions: {
      buyerID?: string;
      supplierID?: string;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional supplierID?: string
    
    ID of the supplier.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/MessageSenders.ts:182

Get

Get<TMessageSender>(messageSenderID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TMessageSender>>
Get a single message sender. Check out the docs for more info
Type Parameters
- TMessageSender extends MessageSender<any, TMessageSender>
Parameters
- messageSenderID: string
  
  ID of the message sender.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TMessageSender>>
- Defined in api/MessageSenders.ts:92

List

List<TMessageSender>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Name" | "URL")[];
    sortBy?: ("ID" | "Name" | "URL" | "!ID" | "!Name" | "!URL")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TMessageSender>>>
Get a list of message senders. Check out the docs for more info
Type Parameters
- TMessageSender extends MessageSender<any, TMessageSender>
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Name" | "URL")[];
      sortBy?: ("ID" | "Name" | "URL" | "!ID" | "!Name" | "!URL")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("ID" | "Name" | "URL")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "Name" | "URL" | "!ID" | "!Name" | "!URL")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TMessageSender>>>
- Defined in api/MessageSenders.ts:50

ListAssignments

ListAssignments<TMessageSenderAssignment>(listOptions?: {
    buyerID?: string;
    level?: PartyType;
    messageSenderID?: string;
    page?: number;
    pageSize?: number;
    supplierID?: string;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TMessageSenderAssignment>>>
Get a list of message sender assignments. Check out the docs for more info
Type Parameters
- TMessageSenderAssignment extends MessageSenderAssignment
Parameters
- listOptions: {
      buyerID?: string;
      level?: PartyType;
      messageSenderID?: string;
      page?: number;
      pageSize?: number;
      supplierID?: string;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional level?: PartyType
    
    Level of the message sender assignment. Possible values: User, Group, Company.
  - Optional messageSenderID?: string
    
    ID of the message sender.
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional supplierID?: string
    
    ID of the supplier.
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TMessageSenderAssignment>>>
- Defined in api/MessageSenders.ts:210

ListCCListenerAssignments

ListCCListenerAssignments<TMessageCCListenerAssignment>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("BuyerID" | "UserID" | "UserGroupID" | "MessageConfigName" | "SupplierID")[];
    sortBy?: ("BuyerID" | "UserID" | "UserGroupID" | "MessageConfigName" | "SupplierID" | "!BuyerID" | "!UserID" | "!UserGroupID" | "!MessageConfigName" | "!SupplierID")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TMessageCCListenerAssignment>>>
Get a list of message sender cc listener assignments. Check out the docs for more info
Type Parameters
- TMessageCCListenerAssignment extends MessageCCListenerAssignment
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("BuyerID" | "UserID" | "UserGroupID" | "MessageConfigName" | "SupplierID")[];
      sortBy?: ("BuyerID" | "UserID" | "UserGroupID" | "MessageConfigName" | "SupplierID" | "!BuyerID" | "!UserID" | "!UserGroupID" | "!MessageConfigName" | "!SupplierID")[];
  } = {}
  - Optional filters?: Filters
    
    An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'
  - Optional page?: number
    
    Page of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.
  - Optional pageSize?: number
    
    Number of results to return per page. Default: 20, max: 100.
  - Optional search?: string
    
    Word or phrase to search for.
  - Optional searchOn?: ("BuyerID" | "UserID" | "UserGroupID" | "MessageConfigName" | "SupplierID")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("BuyerID" | "UserID" | "UserGroupID" | "MessageConfigName" | "SupplierID" | "!BuyerID" | "!UserID" | "!UserGroupID" | "!MessageConfigName" | "!SupplierID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TMessageCCListenerAssignment>>>
- Defined in api/MessageSenders.ts:257

Patch

Patch<TMessageSender>(messageSenderID: string, messageSender: PartialObjectDeep<MessageSender<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TMessageSender>>
Partially update a message sender. Check out the docs for more info
Type Parameters
- TMessageSender extends MessageSender<any, TMessageSender>
Parameters
- messageSenderID: string
  
  ID of the message sender.
- messageSender: PartialObjectDeep<MessageSender<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TMessageSender>>
- Defined in api/MessageSenders.ts:157

Save

Save<TMessageSender>(messageSenderID: string, messageSender: MessageSender<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TMessageSender>>
Create or update a message sender. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TMessageSender extends MessageSender<any, TMessageSender>
Parameters
- messageSenderID: string
  
  ID of the message sender.
- messageSender: MessageSender<any>
  
  Required fields: Name, MessageTypes
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TMessageSender>>
- Defined in api/MessageSenders.ts:114

SaveAssignment

SaveAssignment(messageSenderAssignment: MessageSenderAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a message sender assignment. Check out the docs for more info
Parameters
- messageSenderAssignment: MessageSenderAssignment
  
  Required fields: MessageSenderID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/MessageSenders.ts:231

SaveCCListenerAssignment

SaveCCListenerAssignment(messageCCListenerAssignment: MessageCCListenerAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a message sender cc listener assignment. Check out the docs for more info
Parameters
- messageCCListenerAssignment: MessageCCListenerAssignment
  
  Required fields: MessageSenderAssignment, MessageType
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/MessageSenders.ts:278

Class MessageSenders

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns MessageSenders

Create

Type Parameters

TMessageSender extends MessageSender<any, TMessageSender>

Parameters

messageSender: MessageSender<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TMessageSender>>

Delete

Parameters

messageSenderID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteAssignment

Parameters

messageSenderID: string

listOptions: { buyerID?: string; supplierID?: string; userGroupID?: string; userID?: string; } = {}

Optional buyerID?: string

Optional supplierID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TMessageSender extends MessageSender<any, TMessageSender>

Parameters

messageSenderID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TMessageSender>>

List

Type Parameters

TMessageSender extends MessageSender<any, TMessageSender>

Parameters

listOptions: { filters?: Filters; page?: number; pageSize?: number; search?: string; searchOn?: ("ID" | "Name" | "URL")[]; sortBy?: ("ID" | "Name" | "URL" | "!ID" | "!Name" | "!URL")[]; } = {}

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "Name" | "URL")[]

Optional sortBy?: ("ID" | "Name" | "URL" | "!ID" | "!Name" | "!URL")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TMessageSender>>>

ListAssignments

Type Parameters

TMessageSenderAssignment extends MessageSenderAssignment

Parameters

listOptions: { buyerID?: string; level?: PartyType; messageSenderID?: string; page?: number; pageSize?: number; supplierID?: string; userGroupID?: string; userID?: string; } = {}

Optional buyerID?: string

Optional level?: PartyType

Optional messageSenderID?: string

Optional page?: number

Optional pageSize?: number

Optional supplierID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TMessageSenderAssignment>>>

ListCCListenerAssignments

Type Parameters

TMessageCCListenerAssignment extends MessageCCListenerAssignment

Parameters

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("BuyerID" | "UserID" | "UserGroupID" | "MessageConfigName" | "SupplierID")[]

Optional sortBy?: ("BuyerID" | "UserID" | "UserGroupID" | "MessageConfigName" | "SupplierID" | "!BuyerID" | "!UserID" | "!UserGroupID" | "!MessageConfigName" | "!SupplierID")[]

requestOptions: RequestOptions = {}

`Private` impersonating

listOptions: {
buyerID?: string;
supplierID?: string;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` supplierID?: string

`Optional` userGroupID?: string

`Optional` userID?: string

listOptions: {
filters?: Filters;
page?: number;
pageSize?: number;
search?: string;
searchOn?: ("ID" | "Name" | "URL")[];
sortBy?: ("ID" | "Name" | "URL" | "!ID" | "!Name" | "!URL")[];
} = {}

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "Name" | "URL")[]

`Optional` sortBy?: ("ID" | "Name" | "URL" | "!ID" | "!Name" | "!URL")[]

listOptions: {
buyerID?: string;
level?: PartyType;
messageSenderID?: string;
page?: number;
pageSize?: number;
supplierID?: string;
userGroupID?: string;
userID?: string;
} = {}

`Optional` buyerID?: string

`Optional` level?: PartyType

`Optional` messageSenderID?: string

`Optional` page?: number

`Optional` pageSize?: number

`Optional` supplierID?: string

`Optional` userGroupID?: string

`Optional` userID?: string

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("BuyerID" | "UserID" | "UserGroupID" | "MessageConfigName" | "SupplierID")[]

`Optional` sortBy?: ("BuyerID" | "UserID" | "UserGroupID" | "MessageConfigName" | "SupplierID" | "!BuyerID" | "!UserID" | "!UserGroupID" | "!MessageConfigName" | "!SupplierID")[]