Class CreditCards

Hierarchy

CreditCards

Index

Properties

impersonating

Methods

As Create Delete DeleteAssignment Get List ListAssignments Patch Save SaveAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TCreditCard>(buyerID: string, creditCard: CreditCard<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TCreditCard>>
Create a new credit card. 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
- TCreditCard extends CreditCard<any, TCreditCard>
Parameters
- buyerID: string
  
  ID of the buyer.
- creditCard: CreditCard<any>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCreditCard>>
- Defined in api/CreditCards.ts:70

Delete

Delete(buyerID: string, creditCardID: string, requestOptions?: RequestOptions): Promise<void>
Delete a credit card. Check out the docs for more info
Parameters
- buyerID: string
  
  ID of the buyer.
- creditCardID: string
  
  ID of the credit card.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/CreditCards.ts:137

DeleteAssignment

DeleteAssignment(buyerID: string, creditCardID: string, listOptions?: {
userGroupID?: string;
userID?: string;
}, requestOptions?: RequestOptions): Promise<void>
Delete a credit card assignment. Check out the docs for more info
Parameters
- buyerID: string
  
  ID of the buyer.
- creditCardID: string
  
  ID of the credit card.
- listOptions: {
  userGroupID?: string;
  userID?: string;
  } = {}
  - Optional userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/CreditCards.ts:184

Get

Get<TCreditCard>(buyerID: string, creditCardID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TCreditCard>>
Get a single credit card. Check out the docs for more info
Type Parameters
- TCreditCard extends CreditCard<any, TCreditCard>
Parameters
- buyerID: string
  
  ID of the buyer.
- creditCardID: string
  
  ID of the credit card.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCreditCard>>
- Defined in api/CreditCards.ts:92

List

List<TCreditCard>(buyerID: string, listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate")[];
    sortBy?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate" | "DateCreated" | "!ID" | "!DateCreated" | "!CardholderName" | "!CardType" | "!ExpirationDate")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TCreditCard>>>
Get a list of credit cards. Check out the docs for more info
Type Parameters
- TCreditCard extends CreditCard<any, TCreditCard>
Parameters
- buyerID: string
  
  ID of the buyer.
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate")[];
      sortBy?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate" | "DateCreated" | "!ID" | "!DateCreated" | "!CardholderName" | "!CardType" | "!ExpirationDate")[];
  } = {}
  - 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" | "CardholderName" | "CardType" | "ExpirationDate")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate" | "DateCreated" | "!ID" | "!DateCreated" | "!CardholderName" | "!CardType" | "!ExpirationDate")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TCreditCard>>>
- Defined in api/CreditCards.ts:48

ListAssignments

ListAssignments<TCreditCardAssignment>(buyerID: string, listOptions?: {
    creditCardID?: string;
    level?: PartyType;
    page?: number;
    pageSize?: number;
    userGroupID?: string;
    userID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TCreditCardAssignment>>>
Get a list of credit card assignments. Check out the docs for more info
Type Parameters
- TCreditCardAssignment extends CreditCardAssignment
Parameters
- buyerID: string
  
  ID of the buyer.
- listOptions: {
      creditCardID?: string;
      level?: PartyType;
      page?: number;
      pageSize?: number;
      userGroupID?: string;
      userID?: string;
  } = {}
  - Optional creditCardID?: string
    
    ID of the credit card.
  - Optional level?: PartyType
    
    Level of the credit card assignment. Possible values: User, Group, Company.
  - 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 userGroupID?: string
    
    ID of the user group.
  - Optional userID?: string
    
    ID of the user.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TCreditCardAssignment>>>
- Defined in api/CreditCards.ts:211

Patch

Patch<TCreditCard>(buyerID: string, creditCardID: string, creditCard: PartialObjectDeep<CreditCard<any>>, requestOptions?: RequestOptions): Promise<RequiredDeep<TCreditCard>>
Partially update a credit card. Check out the docs for more info
Type Parameters
- TCreditCard extends CreditCard<any, TCreditCard>
Parameters
- buyerID: string
  
  ID of the buyer.
- creditCardID: string
  
  ID of the credit card.
- creditCard: PartialObjectDeep<CreditCard<any>>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCreditCard>>
- Defined in api/CreditCards.ts:160

Save

Save<TCreditCard>(buyerID: string, creditCardID: string, creditCard: CreditCard<any>, requestOptions?: RequestOptions): Promise<RequiredDeep<TCreditCard>>
Create or update a credit card. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TCreditCard extends CreditCard<any, TCreditCard>
Parameters
- buyerID: string
  
  ID of the buyer.
- creditCardID: string
  
  ID of the credit card.
- creditCard: CreditCard<any>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TCreditCard>>
- Defined in api/CreditCards.ts:115

SaveAssignment

SaveAssignment(buyerID: string, creditCardAssignment: CreditCardAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a credit card assignment. Check out the docs for more info
Parameters
- buyerID: string
  
  ID of the buyer.
- creditCardAssignment: CreditCardAssignment
  
  Required fields: CreditCardID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/CreditCards.ts:233

Class CreditCards

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns CreditCards

Create

Type Parameters

TCreditCard extends CreditCard<any, TCreditCard>

Parameters

buyerID: string

creditCard: CreditCard<any>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TCreditCard>>

Delete

Parameters

buyerID: string

creditCardID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteAssignment

Parameters

buyerID: string

creditCardID: string

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

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TCreditCard extends CreditCard<any, TCreditCard>

Parameters

buyerID: string

creditCardID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TCreditCard>>

List

Type Parameters

TCreditCard extends CreditCard<any, TCreditCard>

Parameters

buyerID: string

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate")[]

Optional sortBy?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate" | "DateCreated" | "!ID" | "!DateCreated" | "!CardholderName" | "!CardType" | "!ExpirationDate")[]

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TCreditCard>>>

ListAssignments

Type Parameters

TCreditCardAssignment extends CreditCardAssignment

Parameters

buyerID: string

listOptions: { creditCardID?: string; level?: PartyType; page?: number; pageSize?: number; userGroupID?: string; userID?: string; } = {}

Optional creditCardID?: string

Optional level?: PartyType

Optional page?: number

Optional pageSize?: number

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TCreditCardAssignment>>>

Patch

Type Parameters

TCreditCard extends CreditCard<any, TCreditCard>

Parameters

buyerID: string

creditCardID: string

creditCard: PartialObjectDeep<CreditCard<any>>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TCreditCard>>

Save

`Private` impersonating

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

`Optional` userGroupID?: string

`Optional` userID?: string

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

`Optional` searchOn?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate")[]

`Optional` sortBy?: ("ID" | "CardholderName" | "CardType" | "ExpirationDate" | "DateCreated" | "!ID" | "!DateCreated" | "!CardholderName" | "!CardType" | "!ExpirationDate")[]

listOptions: {
creditCardID?: string;
level?: PartyType;
page?: number;
pageSize?: number;
userGroupID?: string;
userID?: string;
} = {}

`Optional` creditCardID?: string

`Optional` level?: PartyType

`Optional` page?: number

`Optional` pageSize?: number

`Optional` userGroupID?: string

`Optional` userID?: string