Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SourceCodeGroups

Source Code Groups

Create, update, delete, and search for source code groups.

For instructions on how to retrieve access token for admin APIs: https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html

Example with admin auth

import { Pricing, ClientConfig } from "commerce-sdk";
// or
const { Pricing, ClientConfig } = require("commerce-sdk");

const clientConfig: ClientConfig = {
  parameters: {
    clientId: "XXXXXX",
    organizationId: "XXXX",
    shortCode: "XXX",
    siteId: "XX"
  }
};

token = { access_token: 'INSERT_ACCESS_TOKEN_HERE' };

clientConfig.headers['authorization'] = `Bearer ${token.access_token}`;
const sourceCodeGroupsClient = new Pricing.SourceCodeGroups(clientConfig);
API Version: 1.0.28
Last Updated:

Hierarchy

  • BaseClient
    • SourceCodeGroups

Index

Type aliases

Constructors

Properties

Methods

Type aliases

Static AsyncCreated

AsyncCreated: {}

Type declaration

Static AttributeDefinition

AttributeDefinition: { defaultValue?: PropertyValueDefinition; description: L10nString; id?: string; key?: boolean; localizable?: boolean; mandatory?: boolean; max?: number; min?: number; minLength?: number; multiValueType?: boolean; name: L10nString; possibleValues?: Array<PropertyValueDefinition>; regularExpression?: string; scale?: number; searchable?: boolean; siteSpecific?: boolean; system?: boolean; type: string; unit?: L10nString; visible?: boolean }

Type declaration

  • Optional defaultValue?: PropertyValueDefinition
  • description: L10nString
  • Optional id?: string
  • Optional key?: boolean
  • Optional localizable?: boolean
  • Optional mandatory?: boolean
  • Optional max?: number
  • Optional min?: number
  • Optional minLength?: number
  • Optional multiValueType?: boolean
  • name: L10nString
  • Optional possibleValues?: Array<PropertyValueDefinition>
  • Optional regularExpression?: string
  • Optional scale?: number
  • Optional searchable?: boolean
  • Optional siteSpecific?: boolean
  • Optional system?: boolean
  • type: string
  • Optional unit?: L10nString
  • Optional visible?: boolean

Static BoolFilter

BoolFilter: { filters?: Array<Filter>; operator: string } & {}

Static BoolQuery

BoolQuery: { must?: Array<Query>; mustNot?: Array<Query>; should?: Array<Query> } & {}

Static ChangeControlled

ChangeControlled: { createdBy?: string; creationDate?: any; lastModifiedBy?: string; modificationDate?: any } & {}

Static ChangeControlledDataType

ChangeControlledDataType: { createdBy?: string; creationDate?: any; lastModifiedBy?: string; modificationDate?: any } & {}

Static ClosedObject

ClosedObject: {} & {}

Static DateConditionalRequest

DateConditionalRequest: {}

Type declaration

Static DateRangeFilter

DateRangeFilter: {}

Type declaration

Static DatetimeRangeFilter

DatetimeRangeFilter: {}

Type declaration

Static Error

Error: { detail?: string; instance?: string; title?: string; type: string } & {}

Static ErrorResponse

ErrorResponse: { detail?: string; instance?: string; title?: string; type: string } & {}

Static EtagConditionalRequest

EtagConditionalRequest: {}

Type declaration

Static EtagResponse

EtagResponse: {}

Type declaration

Static Filter

Filter: { boolFilter?: BoolFilter; queryFilter?: QueryFilter; range2Filter?: Range2Filter; rangeFilter?: RangeFilter; termFilter?: TermFilter } & {}

Static FilteredQuery

FilteredQuery: { filter: Filter; query: Query } & {}

Static IdConflict

IdConflict: {}

Type declaration

Static IntegerRangeFilter

IntegerRangeFilter: {}

Type declaration

Static InvalidQuery

InvalidQuery: {}

Type declaration

Static L10nString

L10nString: {} & {}

Static LocalizedString

LocalizedString: {} & {}

Static MatchAllQuery

MatchAllQuery: {} & {}

Static Money

Money: { currencyMnemonic?: string; value?: number } & {}

Static MoneyMnemonic

MoneyMnemonic: { currencyMnemonic?: string; value?: number } & {}

Static NestedQuery

NestedQuery: { path: string; query: Query; scoreMode?: string } & {}

Static NoPropertiesAllowed

NoPropertiesAllowed: {}

Type declaration

Static NumericRangeFilter

NumericRangeFilter: {}

Type declaration

Static OffsetPaginated

OffsetPaginated: {}

Type declaration

Static OpenObject

OpenObject: {} & {}

Static PaginatedSearchResult

PaginatedSearchResult: { hits?: Array<object>; limit: number; offset: any; query: Query; sorts?: Array<Sort>; total: any } & {}

Static PaginatedSearchResultBase

PaginatedSearchResultBase: { hits?: Array<object>; limit: number; offset: any; query: Query; sorts?: Array<Sort>; total: any } & {}

Static PropertyDefinition

PropertyDefinition: { defaultValue?: PropertyValueDefinition; description: L10nString; id?: string; key?: boolean; localizable?: boolean; mandatory?: boolean; max?: number; min?: number; minLength?: number; multiValueType?: boolean; name: L10nString; possibleValues?: Array<PropertyValueDefinition>; regularExpression?: string; scale?: number; searchable?: boolean; siteSpecific?: boolean; system?: boolean; type: string; unit?: L10nString; visible?: boolean } & {}

Static PropertyValueDefinition

PropertyValueDefinition: { description: L10nString; displayValue: L10nString; id: string; position?: number; value: string }

Type declaration

  • description: L10nString
  • displayValue: L10nString
  • id: string
  • Optional position?: number
  • value: string

Static Query

Query: { boolQuery?: BoolQuery; filteredQuery?: FilteredQuery; matchAllQuery?: MatchAllQuery; nestedQuery?: NestedQuery; termQuery?: TermQuery; textQuery?: TextQuery } & {}

Static QueryFilter

QueryFilter: { query: Query } & {}

Static QueryParamsLimit

QueryParamsLimit: {}

Type declaration

Static QueryParamsOffset

QueryParamsOffset: {}

Type declaration

Static Range2Filter

Range2Filter: { filterMode?: string; fromField: string; fromInclusive?: boolean; fromValue?: any; toField: string; toInclusive?: boolean; toValue?: any } & {}

Static RangeFilter

RangeFilter: {}

Type declaration

Static RateLimited

RateLimited: {}

Type declaration

Static RateLimited2

RateLimited2: {}

Type declaration

Static RateLimited3

RateLimited3: {}

Type declaration

Static RateLimited4

RateLimited4: {}

Type declaration

Static RateLimited5

RateLimited5: {}

Type declaration

Static SearchRequest

SearchRequest: { limit?: number; offset?: any; query: Query; sorts?: Array<Sort> } & {}

Static SearchRequestBase

SearchRequestBase: { limit?: number; offset?: any; query: Query; sorts?: Array<Sort> } & {}

Static Selectable

Selectable: {}

Type declaration

Static SimpleSearchResult

SimpleSearchResult: { hits?: Array<object>; limit: number; offset: any; total: any } & {}

Static SimpleSearchResultBase

SimpleSearchResultBase: { hits?: Array<object>; limit: number; offset: any; total: any } & {}

Static SiteSpecific

SiteSpecific: {}

Type declaration

Static Sort

Sort: { field: string; sortOrder?: string } & {}

Static SourceCodeGroup

SourceCodeGroup: { active?: boolean; activeRedirect?: SourceCodeRedirectInfo; cookieDuration?: number; creationDate?: any; description?: string; enabled?: boolean; endTime?: any; id: string; inactiveRedirect?: SourceCodeRedirectInfo; lastModified?: any; specifications?: Array<SourceCodeSpecification>; startTime?: any } & {}

Static SourceCodeGroupInvalid

SourceCodeGroupInvalid: {}

Type declaration

Static SourceCodeGroupNotFound

SourceCodeGroupNotFound: {}

Type declaration

Static SourceCodeGroupSearchResult

SourceCodeGroupSearchResult: { hits: Array<SourceCodeGroup>; limit: number; offset: any; query: Query; sorts?: Array<Sort>; total: any } & {}

Static SourceCodeRedirectInfo

SourceCodeRedirectInfo: { location?: string; locationType: string }

Type declaration

  • Optional location?: string
  • locationType: string

Static SourceCodeSpecification

SourceCodeSpecification: { expression: string }

Type declaration

  • expression: string

Static SpecifiedPropertiesAllowed

SpecifiedPropertiesAllowed: {} & {}

Static SyncCreated

SyncCreated: {}

Type declaration

Static TermFilter

TermFilter: { field: string; operator: string; values?: Array<any> } & {}

Static TermQuery

TermQuery: { fields: Array<string>; operator: string; values?: Array<any> } & {}

Static TextQuery

TextQuery: { fields: Array<string>; searchPhrase: string } & {}

Constructors

constructor

  • Parameters

    • config: ClientConfig

    Returns SourceCodeGroups

Properties

clientConfig

clientConfig: ClientConfig

Methods

createSourceCodeGroup

  • createSourceCodeGroup(options: { body: SourceCodeGroup; fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }): Promise<SourceCodeGroup>
  • createSourceCodeGroup<T>(options: { body: SourceCodeGroup; fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }, rawResponse?: T): Promise<T extends true ? Response : SourceCodeGroups.SourceCodeGroup>

  • Creates a source code group using the information provided.

    If you would like to get a raw Response object use the other createSourceCodeGroup function.

    Parameters

    • options: { body: SourceCodeGroup; fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }

      An object containing the options for this method.

      • body: SourceCodeGroup
      • Optional fetchOptions?: RequestInit
      • Optional headers?: {}
        • [key: string]: string
      • Optional parameters?: { id: string; organizationId?: string; siteId?: string } & {}
      • Optional retrySettings?: OperationOptions

    Returns Promise<SourceCodeGroup>

    A promise of type SourceCodeGroups.SourceCodeGroup.

  • Creates a source code group using the information provided.

    Type parameters

    • T: boolean

    Parameters

    • options: { body: SourceCodeGroup; fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }

      An object containing the options for this method.

      • body: SourceCodeGroup
      • Optional fetchOptions?: RequestInit
      • Optional headers?: {}
        • [key: string]: string
      • Optional parameters?: { id: string; organizationId?: string; siteId?: string } & {}
      • Optional retrySettings?: OperationOptions
    • Optional rawResponse: T

      Set to true to return entire Response object instead of DTO.

    Returns Promise<T extends true ? Response : SourceCodeGroups.SourceCodeGroup>

    A promise of type Response if rawResponse is true, a promise of type SourceCodeGroups.SourceCodeGroup otherwise.

deleteSourceCodeGroup

  • deleteSourceCodeGroup(options?: { fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }): Promise<void>
  • deleteSourceCodeGroup<T>(options?: { fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }, rawResponse?: T): Promise<T extends true ? Response : void>

  • Deletes the source code group by ID.

    If you would like to get a raw Response object use the other deleteSourceCodeGroup function.

    Parameters

    • Optional options: { fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }

      An object containing the options for this method.

      • Optional fetchOptions?: RequestInit
      • Optional headers?: {}
        • [key: string]: string
      • Optional parameters?: { id: string; organizationId?: string; siteId?: string } & {}
      • Optional retrySettings?: OperationOptions

    Returns Promise<void>

    A promise of type void.

  • Deletes the source code group by ID.

    Type parameters

    • T: boolean

    Parameters

    • Optional options: { fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }

      An object containing the options for this method.

      • Optional fetchOptions?: RequestInit
      • Optional headers?: {}
        • [key: string]: string
      • Optional parameters?: { id: string; organizationId?: string; siteId?: string } & {}
      • Optional retrySettings?: OperationOptions
    • Optional rawResponse: T

      Set to true to return entire Response object instead of DTO.

    Returns Promise<T extends true ? Response : void>

    A promise of type Response if rawResponse is true, a promise of type void otherwise.

getSourceCodeGroup

  • getSourceCodeGroup(options?: { fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }): Promise<SourceCodeGroup>
  • getSourceCodeGroup<T>(options?: { fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }, rawResponse?: T): Promise<T extends true ? Response : SourceCodeGroups.SourceCodeGroup>

  • Action to retrieve source code group information.

    If you would like to get a raw Response object use the other getSourceCodeGroup function.

    Parameters

    • Optional options: { fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }

      An object containing the options for this method.

      • Optional fetchOptions?: RequestInit
      • Optional headers?: {}
        • [key: string]: string
      • Optional parameters?: { id: string; organizationId?: string; siteId?: string } & {}
      • Optional retrySettings?: OperationOptions

    Returns Promise<SourceCodeGroup>

    A promise of type SourceCodeGroups.SourceCodeGroup.

  • Action to retrieve source code group information.

    Type parameters

    • T: boolean

    Parameters

    • Optional options: { fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }

      An object containing the options for this method.

      • Optional fetchOptions?: RequestInit
      • Optional headers?: {}
        • [key: string]: string
      • Optional parameters?: { id: string; organizationId?: string; siteId?: string } & {}
      • Optional retrySettings?: OperationOptions
    • Optional rawResponse: T

      Set to true to return entire Response object instead of DTO.

    Returns Promise<T extends true ? Response : SourceCodeGroups.SourceCodeGroup>

    A promise of type Response if rawResponse is true, a promise of type SourceCodeGroups.SourceCodeGroup otherwise.

sourceCodeGroupsSearch

  • sourceCodeGroupsSearch(options: { body: SearchRequest; fetchOptions?: RequestInit; headers?: {}; parameters?: { organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }): Promise<SourceCodeGroupSearchResult>
  • sourceCodeGroupsSearch<T>(options: { body: SearchRequest; fetchOptions?: RequestInit; headers?: {}; parameters?: { organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }, rawResponse?: T): Promise<T extends true ? Response : SourceCodeGroups.SourceCodeGroupSearchResult>

  • Searches for source code groups.

    The query attribute specifies a complex query that can be used to narrow down the search with the following searchable attributes:

    Attribute Type
    id String
    description String
    sourceCode String
    startTime DateTime
    endTime DateTime
    creationDate DateTime
    enabled Boolean
    active Boolean

    The sourceCode and active fields can only be used in Queries as conjunctions (using AND). If the field is used in a disjunction (OR) an exception will be thrown.

    The output of the query can also be sorted, with the following sortable attributes:

    Attribute Type
    id String
    description String
    enabled Boolean
    creationDate DateTime

    If you would like to get a raw Response object use the other sourceCodeGroupsSearch function.

    Parameters

    • options: { body: SearchRequest; fetchOptions?: RequestInit; headers?: {}; parameters?: { organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }

      An object containing the options for this method.

      • body: SearchRequest
      • Optional fetchOptions?: RequestInit
      • Optional headers?: {}
        • [key: string]: string
      • Optional parameters?: { organizationId?: string; siteId?: string } & {}
      • Optional retrySettings?: OperationOptions

    Returns Promise<SourceCodeGroupSearchResult>

    A promise of type SourceCodeGroups.SourceCodeGroupSearchResult.

  • Searches for source code groups.

    The query attribute specifies a complex query that can be used to narrow down the search with the following searchable attributes:

    Attribute Type
    id String
    description String
    sourceCode String
    startTime DateTime
    endTime DateTime
    creationDate DateTime
    enabled Boolean
    active Boolean

    The sourceCode and active fields can only be used in Queries as conjunctions (using AND). If the field is used in a disjunction (OR) an exception will be thrown.

    The output of the query can also be sorted, with the following sortable attributes:

    Attribute Type
    id String
    description String
    enabled Boolean
    creationDate DateTime

    Type parameters

    • T: boolean

    Parameters

    • options: { body: SearchRequest; fetchOptions?: RequestInit; headers?: {}; parameters?: { organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }

      An object containing the options for this method.

      • body: SearchRequest
      • Optional fetchOptions?: RequestInit
      • Optional headers?: {}
        • [key: string]: string
      • Optional parameters?: { organizationId?: string; siteId?: string } & {}
      • Optional retrySettings?: OperationOptions
    • Optional rawResponse: T

      Set to true to return entire Response object instead of DTO.

    Returns Promise<T extends true ? Response : SourceCodeGroups.SourceCodeGroupSearchResult>

    A promise of type Response if rawResponse is true, a promise of type SourceCodeGroups.SourceCodeGroupSearchResult otherwise.

updateSourceCodeGroup

  • updateSourceCodeGroup(options: { body: SourceCodeGroup; fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }): Promise<SourceCodeGroup>
  • updateSourceCodeGroup<T>(options: { body: SourceCodeGroup; fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }, rawResponse?: T): Promise<T extends true ? Response : SourceCodeGroups.SourceCodeGroup>

  • Updates the source code group with the specified information.

    If you would like to get a raw Response object use the other updateSourceCodeGroup function.

    Parameters

    • options: { body: SourceCodeGroup; fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }

      An object containing the options for this method.

      • body: SourceCodeGroup
      • Optional fetchOptions?: RequestInit
      • Optional headers?: {}
        • [key: string]: string
      • Optional parameters?: { id: string; organizationId?: string; siteId?: string } & {}
      • Optional retrySettings?: OperationOptions

    Returns Promise<SourceCodeGroup>

    A promise of type SourceCodeGroups.SourceCodeGroup.

  • Updates the source code group with the specified information.

    Type parameters

    • T: boolean

    Parameters

    • options: { body: SourceCodeGroup; fetchOptions?: RequestInit; headers?: {}; parameters?: { id: string; organizationId?: string; siteId?: string } & {}; retrySettings?: OperationOptions }

      An object containing the options for this method.

      • body: SourceCodeGroup
      • Optional fetchOptions?: RequestInit
      • Optional headers?: {}
        • [key: string]: string
      • Optional parameters?: { id: string; organizationId?: string; siteId?: string } & {}
      • Optional retrySettings?: OperationOptions
    • Optional rawResponse: T

      Set to true to return entire Response object instead of DTO.

    Returns Promise<T extends true ? Response : SourceCodeGroups.SourceCodeGroup>

    A promise of type Response if rawResponse is true, a promise of type SourceCodeGroups.SourceCodeGroup otherwise.

Generated using TypeDoc