JSDoc: Class: AvailabilityGroupPaymentMethodUpdateAssigned

Class: AvailabilityGroupPaymentMethodUpdateAssigned

Request~AvailabilityGroupPaymentMethodUpdateAssigned(clientnullable, availabilityGroupnullable)

Handles API Request AvailabilityGroupPaymentMethod_Update_Assigned. Scope: Store.

Constructor

new AvailabilityGroupPaymentMethodUpdateAssigned(clientnullable, availabilityGroupnullable)

AvailabilityGroupPaymentMethodUpdateAssigned Constructor.

Parameters:

Name	Type	Attributes	Default	Description
`client`	Client	<nullable>
`availabilityGroup`	AvailabilityGroup	<nullable>	null

Source:

requests.js, line 438

See:

https://docs.miva.com/json-api/functions/availabilitygrouppaymentmethod_update_assigned

Methods

createResponse() → {Response}

Create a response object from the response data.

Source:

requests.js, line 619

Returns:

Type: Response

getAssigned() → {boolean}

Get Assigned.

Source:

requests.js, line 511

Returns:

Type: boolean

getAvailabilityGroupId() → {number}

Get AvailabilityGroup_ID.

Source:

requests.js, line 463

Returns:

Type: number

getAvailabilityGroupName() → {string}

Get AvailabilityGroup_Name.

Source:

requests.js, line 479

Returns:

Type: string

getEditAvailabilityGroup() → {string}

Get Edit_AvailabilityGroup.

Source:

requests.js, line 471

Returns:

Type: string

getMethodCode() → {string}

Get Method_Code.

Source:

requests.js, line 495

Returns:

Type: string

getModuleCode() → {string}

Get Module_Code.

Source:

requests.js, line 487

Returns:

Type: string

getPaymentCardTypeId() → {number}

Get PaymentCardType_ID.

Source:

requests.js, line 503

Returns:

Type: number

setAssigned(assigned) → {AvailabilityGroupPaymentMethodUpdateAssigned}

Set Assigned.

Parameters:

Name	Type	Description
`assigned`	boolean

Source:

requests.js, line 580

Returns:

Type: AvailabilityGroupPaymentMethodUpdateAssigned

setAvailabilityGroupId(availabilityGroupId) → {AvailabilityGroupPaymentMethodUpdateAssigned}

Set AvailabilityGroup_ID.

Parameters:

Name	Type	Description
`availabilityGroupId`	number

Source:

requests.js, line 520

Returns:

Type: AvailabilityGroupPaymentMethodUpdateAssigned

setAvailabilityGroupName(availabilityGroupName) → {AvailabilityGroupPaymentMethodUpdateAssigned}

Set AvailabilityGroup_Name.

Parameters:

Name	Type	Description
`availabilityGroupName`	string

Source:

requests.js, line 540

Returns:

Type: AvailabilityGroupPaymentMethodUpdateAssigned

setEditAvailabilityGroup(editAvailabilityGroup) → {AvailabilityGroupPaymentMethodUpdateAssigned}

Set Edit_AvailabilityGroup.

Parameters:

Name	Type	Description
`editAvailabilityGroup`	string

Source:

requests.js, line 530

Returns:

Type: AvailabilityGroupPaymentMethodUpdateAssigned

setMethodCode(methodCode) → {AvailabilityGroupPaymentMethodUpdateAssigned}

Set Method_Code.

Parameters:

Name	Type	Description
`methodCode`	string

Source:

requests.js, line 560

Returns:

Type: AvailabilityGroupPaymentMethodUpdateAssigned

setModuleCode(moduleCode) → {AvailabilityGroupPaymentMethodUpdateAssigned}

Set Module_Code.

Parameters:

Name	Type	Description
`moduleCode`	string

Source:

requests.js, line 550

Returns:

Type: AvailabilityGroupPaymentMethodUpdateAssigned

setPaymentCardTypeId(paymentCardTypeId) → {AvailabilityGroupPaymentMethodUpdateAssigned}

Set PaymentCardType_ID.

Parameters:

Name	Type	Description
`paymentCardTypeId`	number

Source:

requests.js, line 570

Returns:

Type: AvailabilityGroupPaymentMethodUpdateAssigned

toObject() → {Object}

Reduce the request to a an object.

Source:

requests.js, line 590

Returns:

Type: Object