Class StyleGuides

Hierarchy (view full)

CrowdinApi
- StyleGuides

Index

Constructors

Methods

createStyleGuide deleteStyleGuide editStyleGuide getStyleGuide graphql listStyleGuides withFetchAll

Constructors

constructor

new StyleGuides(credentials, config?): StyleGuides
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns StyleGuides
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:237

Methods

createStyleGuide

createStyleGuide(request): Promise<ResponseObject<StyleGuide | StyleGuideEnterprise>>
Parameters
- request: CreateStyleGuideRequest | CreateStyleGuideEnterpriseRequest
  request body
Returns Promise<ResponseObject<StyleGuide | StyleGuideEnterprise>>
See
https://developer.crowdin.com/api/v2/#operation/api.style-guides.post
- Defined in styleGuides/index.ts:21

deleteStyleGuide

deleteStyleGuide(styleGuideId): Promise<void>
Parameters
- styleGuideId: number
  style guide identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.style-guides.delete
- Defined in styleGuides/index.ts:43

editStyleGuide

editStyleGuide(styleGuideId, request): Promise<ResponseObject<StyleGuide | StyleGuideEnterprise>>
Parameters
- styleGuideId: number
  style guide identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<StyleGuide | StyleGuideEnterprise>>
See
https://developer.crowdin.com/api/v2/#operation/api.style-guides.patch
- Defined in styleGuides/index.ts:53

getStyleGuide

getStyleGuide(styleGuideId): Promise<ResponseObject<StyleGuide | StyleGuideEnterprise>>
Parameters
- styleGuideId: number
  style guide identifier
Returns Promise<ResponseObject<StyleGuide | StyleGuideEnterprise>>
See
https://developer.crowdin.com/api/v2/#operation/api.style-guides.get
- Defined in styleGuides/index.ts:32

graphql

graphql<T>(req, config?): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
- config: {
  url?: string;
  } = {}
  - Optionalurl?: string
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:272

listStyleGuides

listStyleGuides(options?): Promise<ResponseList<StyleGuide | StyleGuideEnterprise>>
Parameters
- Optionaloptions: ListStyleGuidesOptions
  optional parameters for the request
Returns Promise<ResponseList<StyleGuide | StyleGuideEnterprise>>
See
https://developer.crowdin.com/api/v2/#operation/api.style-guides.getMany
- Defined in styleGuides/index.ts:8

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:334