Module: CloudPDF::Internal::Types::Union

Includes:
Type
Included in:
Boolean, Types::DocAnnotationsCreate200ResponseMetaAffectedPagesItemWeakAnnotationState, Types::DocAnnotationsDelete200ResponseMetaAffectedPagesItemWeakAnnotationState, Types::DocAnnotationsList200ResponseAnnotationsItem, Types::DocAnnotationsList200ResponseAnnotationsItemCaretInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemCaretRef, Types::DocAnnotationsList200ResponseAnnotationsItemCircleInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemCircleRef, Types::DocAnnotationsList200ResponseAnnotationsItemFileAttachmentInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemFileAttachmentRef, Types::DocAnnotationsList200ResponseAnnotationsItemFreeTextInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemFreeTextRef, Types::DocAnnotationsList200ResponseAnnotationsItemHighlightInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemHighlightRef, Types::DocAnnotationsList200ResponseAnnotationsItemInkInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemInkRef, Types::DocAnnotationsList200ResponseAnnotationsItemLineInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemLineRef, Types::DocAnnotationsList200ResponseAnnotationsItemLinkInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemLinkRef, Types::DocAnnotationsList200ResponseAnnotationsItemLinkTarget, Types::DocAnnotationsList200ResponseAnnotationsItemLinkTargetGotoDestination, Types::DocAnnotationsList200ResponseAnnotationsItemPolygonInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemPolygonRef, Types::DocAnnotationsList200ResponseAnnotationsItemPolylineInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemPolylineRef, Types::DocAnnotationsList200ResponseAnnotationsItemRedactInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemRedactRef, Types::DocAnnotationsList200ResponseAnnotationsItemSquareInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemSquareRef, Types::DocAnnotationsList200ResponseAnnotationsItemSquigglyInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemSquigglyRef, Types::DocAnnotationsList200ResponseAnnotationsItemStampInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemStampRef, Types::DocAnnotationsList200ResponseAnnotationsItemStrikeoutInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemStrikeoutRef, Types::DocAnnotationsList200ResponseAnnotationsItemTextInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemTextRef, Types::DocAnnotationsList200ResponseAnnotationsItemUnderlineInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemUnderlineRef, Types::DocAnnotationsList200ResponseAnnotationsItemUnsupportedInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemUnsupportedRef, Types::DocAnnotationsList200ResponseAnnotationsItemWidgetInReplyTo, Types::DocAnnotationsList200ResponseAnnotationsItemWidgetRef, Types::DocAnnotationsList200ResponsePageStateWeakAnnotationState, Types::DocAnnotationsUpdate200ResponseMetaAffectedPagesItemWeakAnnotationState, Types::DocFormsGet200ResponseCalculationOrderItem, Types::DocFormsGet200ResponseFieldsItem, Types::DocFormsGet200ResponseFieldsItemCheckboxDefaultValueEntry, Types::DocFormsGet200ResponseFieldsItemCheckboxRef, Types::DocFormsGet200ResponseFieldsItemCheckboxValueEntry, Types::DocFormsGet200ResponseFieldsItemComboboxDefaultValueEntry, Types::DocFormsGet200ResponseFieldsItemComboboxRef, Types::DocFormsGet200ResponseFieldsItemComboboxValueEntry, Types::DocFormsGet200ResponseFieldsItemListboxDefaultValueEntry, Types::DocFormsGet200ResponseFieldsItemListboxRef, Types::DocFormsGet200ResponseFieldsItemListboxValueEntry, Types::DocFormsGet200ResponseFieldsItemPushbuttonDefaultValueEntry, Types::DocFormsGet200ResponseFieldsItemPushbuttonRef, Types::DocFormsGet200ResponseFieldsItemPushbuttonValueEntry, Types::DocFormsGet200ResponseFieldsItemRadioDefaultValueEntry, Types::DocFormsGet200ResponseFieldsItemRadioRef, Types::DocFormsGet200ResponseFieldsItemRadioValueEntry, Types::DocFormsGet200ResponseFieldsItemSignatureDefaultValueEntry, Types::DocFormsGet200ResponseFieldsItemSignatureRef, Types::DocFormsGet200ResponseFieldsItemSignatureValueEntry, Types::DocFormsGet200ResponseFieldsItemTextDefaultValueEntry, Types::DocFormsGet200ResponseFieldsItemTextRef, Types::DocFormsGet200ResponseFieldsItemTextValueEntry, Types::DocFormsGet200ResponseFieldsItemUnknownDefaultValueEntry, Types::DocFormsGet200ResponseFieldsItemUnknownRef, Types::DocFormsGet200ResponseFieldsItemUnknownValueEntry, Types::DocFormsImportData200ResponseMetaAffectedPagesItemWeakAnnotationState, Types::DocFormsReset200ResponseMetaAffectedPagesItemWeakAnnotationState, Types::DocFormsSetValue200ResponseMetaAffectedPagesItemWeakAnnotationState, Types::DocManifest200ResponsePagesItemStateWeakAnnotationState, Types::DocPagesDelete200ResponseMetaAffectedPagesItemWeakAnnotationState, Types::DocPagesFlatten200ResponseMetaAffectedPagesItemWeakAnnotationState, Types::DocPagesMove200ResponseMetaAffectedPagesItemWeakAnnotationState, Types::DocPagesRotate200ResponseMetaAffectedPagesItemWeakAnnotationState, Types::DocRedactionsApply200ResponseMetaAffectedPagesItemWeakAnnotationState, Types::DocumentsInit200Response, Types::DocumentsInit200ResponseCreatedUpload, Types::DocumentsInit200ResponseResumedUpload, Types::TokensIssueRequest, Types::TokensIssueRequestTenantScopeItem
Defined in:
lib/CloudPDF/internal/types/union.rb

Overview

Define a union between two types

Instance Method Summary collapse

Methods included from Type

#strict!, #strict?

Methods included from JSON::Serializable

#dump

Instance Method Details

#coerce(value, strict: strict?) ) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/CloudPDF/internal/types/union.rb', line 122

def coerce(value, strict: strict?)
  type = resolve_member(value)

  unless type
    return value unless strict

    if discriminated?
      raise Errors::TypeError,
            "value of type `#{value.class}` not member of union #{self}"
    end

    raise Errors::TypeError, "could not resolve to member of union #{self}"
  end

  coerced = Utils.coerce(type, value, strict: strict)

  # For discriminated unions, store the discriminant info on the coerced instance
  # so it can be injected back during serialization (to_h)
  if discriminated? && value.is_a?(::Hash) && coerced.is_a?(Model)
    discriminant_value = value.fetch(@discriminant, nil) || value.fetch(@discriminant.to_s, nil)
    if discriminant_value
      coerced.instance_variable_set(:@_fern_union_discriminant_key, @discriminant.to_s)
      coerced.instance_variable_set(:@_fern_union_discriminant_value, discriminant_value)
    end
  end

  coerced
end

#discriminant(key) ⇒ void

This method returns an undefined value.

Set the discriminant for this union

Parameters:

  • key (Symbol, String) 


32
33
34
 
# File 'lib/CloudPDF/internal/types/union.rb', line 32

def discriminant(key)
  @discriminant = key
end

#load(str) ⇒ Object

Parse JSON string and coerce to the correct union member type

Parameters:

  • str (String) —

    JSON string to parse

Returns:

  • (Object) —

    Coerced value matching a union member



155
156
157
 
# File 'lib/CloudPDF/internal/types/union.rb', line 155

def load(str)
  coerce(::JSON.parse(str, symbolize_names: true))
end

#member(type, key: nil) ⇒ void

This method returns an undefined value.

Add a member to this union

Parameters:

  • type (Object)
  • key (Hash) (defaults to: nil) —

    a customizable set of options

Options Hash (key:):

  • (Symbol, String) 


19
20
21
22
 
# File 'lib/CloudPDF/internal/types/union.rb', line 19

def member(type, key: nil)
  members.push([key, Utils.wrap_type(type)])
  self
end

#members ⇒ Object 



10
11
12
 
# File 'lib/CloudPDF/internal/types/union.rb', line 10

def members
  @members ||= []
end

#type_member?(type) ⇒ Boolean

Returns:



24
25
26
 
# File 'lib/CloudPDF/internal/types/union.rb', line 24

def type_member?(type)
  members.any? { |_key, type_fn| type == type_fn.call }
end