Class Locales

Hierarchy

Locales

Index

Properties

impersonating

Methods

As Create Delete DeleteAssignment Get List ListAssignments Patch Save SaveAssignment

Properties

`Private` impersonating

impersonating: boolean = false

Methods

As

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

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

Create

Create<TLocale>(locale: Locale, requestOptions?: RequestOptions): Promise<RequiredDeep<TLocale>>
Create a new locale. 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
- TLocale extends Locale
Parameters
- locale: Locale
  
  Required fields: Currency
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TLocale>>
- Defined in api/Locales.ts:67

Delete

Delete(localeID: string, requestOptions?: RequestOptions): Promise<void>
Delete a locale. Check out the docs for more info
Parameters
- localeID: string
  
  ID of the locale.
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Locales.ts:131

DeleteAssignment

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

Get

Get<TLocale>(localeID: string, requestOptions?: RequestOptions): Promise<RequiredDeep<TLocale>>
Get a single locale. Check out the docs for more info
Type Parameters
- TLocale extends Locale
Parameters
- localeID: string
  
  ID of the locale.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TLocale>>
- Defined in api/Locales.ts:88

List

List<TLocale>(listOptions?: {
    filters?: Filters;
    page?: number;
    pageSize?: number;
    search?: string;
    searchOn?: ("ID" | "Currency")[];
    sortBy?: ("ID" | "!ID")[];
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TLocale>>>
Get a list of locales. Check out the docs for more info
Type Parameters
- TLocale extends Locale
Parameters
- listOptions: {
      filters?: Filters;
      page?: number;
      pageSize?: number;
      search?: string;
      searchOn?: ("ID" | "Currency")[];
      sortBy?: ("ID" | "!ID")[];
  } = {}
  - 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" | "Currency")[]
    
    Comma-delimited list of fields to search on.
  - Optional sortBy?: ("ID" | "!ID")[]
    
    Comma-delimited list of fields to sort by.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TLocale>>>
- Defined in api/Locales.ts:46

ListAssignments

ListAssignments<TLocaleAssignment>(listOptions?: {
    buyerID?: string;
    level?: "Group" | "Company";
    localeID?: string;
    page?: number;
    pageSize?: number;
    userGroupID?: string;
}, requestOptions?: RequestOptions): Promise<RequiredObjectDeep<ListPage<TLocaleAssignment>>>
Get a list of locale assignments. Check out the docs for more info
Type Parameters
- TLocaleAssignment extends LocaleAssignment
Parameters
- listOptions: {
      buyerID?: string;
      level?: "Group" | "Company";
      localeID?: string;
      page?: number;
      pageSize?: number;
      userGroupID?: string;
  } = {}
  - Optional buyerID?: string
    
    ID of the buyer.
  - Optional level?: "Group" | "Company"
    
    Level of the locale assignment. Possible values: Group, Company.
  - Optional localeID?: string
    
    ID of the locale.
  - 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.
- requestOptions: RequestOptions = {}
Returns Promise<RequiredObjectDeep<ListPage<TLocaleAssignment>>>
- Defined in api/Locales.ts:203

Patch

Patch<TLocale>(localeID: string, locale: PartialObjectDeep<Locale>, requestOptions?: RequestOptions): Promise<RequiredDeep<TLocale>>
Partially update a locale. Check out the docs for more info
Type Parameters
- TLocale extends Locale
Parameters
- localeID: string
  
  ID of the locale.
- locale: PartialObjectDeep<Locale>
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TLocale>>
- Defined in api/Locales.ts:153

Save

Save<TLocale>(localeID: string, locale: Locale, requestOptions?: RequestOptions): Promise<RequiredDeep<TLocale>>
Create or update a locale. If an object with the same ID already exists, it will be overwritten. Check out the docs for more info
Type Parameters
- TLocale extends Locale
Parameters
- localeID: string
  
  ID of the locale.
- locale: Locale
  
  Required fields: Currency
- requestOptions: RequestOptions = {}
Returns Promise<RequiredDeep<TLocale>>
- Defined in api/Locales.ts:110

SaveAssignment

SaveAssignment(localeAssignment: LocaleAssignment, requestOptions?: RequestOptions): Promise<void>
Create or update a locale assignment. Do not assign a user multiple groups with different assigned locales. That is considered a misconfiguration, and will yield unexpected results. Check out the docs for more info
Parameters
- localeAssignment: LocaleAssignment
  
  Required fields: LocaleID, BuyerID
- requestOptions: RequestOptions = {}
Returns Promise<void>
- Defined in api/Locales.ts:224

Class Locales

Hierarchy

Index

Properties

Methods

Properties

Private impersonating

Methods

As

Description

Example

Returns Locales

Create

Type Parameters

TLocale extends Locale

Parameters

locale: Locale

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TLocale>>

Delete

Parameters

localeID: string

requestOptions: RequestOptions = {}

Returns Promise<void>

DeleteAssignment

Parameters

localeID: string

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

Optional buyerID?: string

Optional userGroupID?: string

Optional userID?: string

requestOptions: RequestOptions = {}

Returns Promise<void>

Get

Type Parameters

TLocale extends Locale

Parameters

localeID: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TLocale>>

List

Type Parameters

TLocale extends Locale

Parameters

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

Optional filters?: Filters

Optional page?: number

Optional pageSize?: number

Optional search?: string

Optional searchOn?: ("ID" | "Currency")[]

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

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TLocale>>>

ListAssignments

Type Parameters

TLocaleAssignment extends LocaleAssignment

Parameters

listOptions: { buyerID?: string; level?: "Group" | "Company"; localeID?: string; page?: number; pageSize?: number; userGroupID?: string; } = {}

Optional buyerID?: string

Optional level?: "Group" | "Company"

Optional localeID?: string

Optional page?: number

Optional pageSize?: number

Optional userGroupID?: string

requestOptions: RequestOptions = {}

Returns Promise<RequiredObjectDeep<ListPage<TLocaleAssignment>>>

Patch

Type Parameters

TLocale extends Locale

Parameters

localeID: string

locale: PartialObjectDeep<Locale>

requestOptions: RequestOptions = {}

Returns Promise<RequiredDeep<TLocale>>

Save

Type Parameters

TLocale extends Locale

Parameters

localeID: string

locale: Locale

`Private` impersonating

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

`Optional` buyerID?: string

`Optional` userGroupID?: string

`Optional` userID?: string

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

`Optional` filters?: Filters

`Optional` page?: number

`Optional` pageSize?: number

`Optional` search?: string

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

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

listOptions: {
buyerID?: string;
level?: "Group" | "Company";
localeID?: string;
page?: number;
pageSize?: number;
userGroupID?: string;
} = {}

`Optional` buyerID?: string

`Optional` level?: "Group" | "Company"

`Optional` localeID?: string

`Optional` page?: number

`Optional` pageSize?: number

`Optional` userGroupID?: string