Class: StarkInfra::IssuingDesign

Inherits:
StarkCore::Utils::Resource
  • Object
show all
Defined in:
lib/issuing_design/issuing_design.rb

Overview

# IssuingDesign object

The IssuingDesign object displays information on the card and card package designs available to your Workspace.

## Attributes (return-only):

  • id [string]: unique id returned when IssuingDesign is created. ex: “5656565656565656”

  • name [string]: card or package design name. ex: “stark-plastic-dark-001”

  • embosser_ids [list of strings]: list of embosser unique ids. ex: [“5136459887542272”, “5136459887542273”]

  • type [string]: card or package design type. Options: “card”, “envelope”

  • updated [DateTime]: latest update datetime for the IssuingDesign. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)

  • created [DateTime]: creation datetime for the IssuingDesign. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: nil, name: nil, embosser_ids: nil, type: nil, updated: nil, created: nil) ⇒ IssuingDesign

Returns a new instance of IssuingDesign.



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/issuing_design/issuing_design.rb', line 20

def initialize(
  id: nil, name: nil, embosser_ids: nil, type: nil, updated: nil, created: nil
)
  super(id)
  @name = name
  @embosser_ids = embosser_ids
  @type = type
  @updated = StarkCore::Utils::Checks.check_datetime(updated)
  @created = StarkCore::Utils::Checks.check_datetime(created)
end

Instance Attribute Details

#created ⇒ Object (readonly)

Returns the value of attribute created.



19
20
21
 
# File 'lib/issuing_design/issuing_design.rb', line 19

def created
  @created
end

#embosser_ids ⇒ Object (readonly)

Returns the value of attribute embosser_ids.



19
20
21
 
# File 'lib/issuing_design/issuing_design.rb', line 19

def embosser_ids
  @embosser_ids
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



19
20
21
 
# File 'lib/issuing_design/issuing_design.rb', line 19

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



19
20
21
 
# File 'lib/issuing_design/issuing_design.rb', line 19

def name
  @name
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



19
20
21
 
# File 'lib/issuing_design/issuing_design.rb', line 19

def type
  @type
end

#updated ⇒ Object (readonly)

Returns the value of attribute updated.



19
20
21
 
# File 'lib/issuing_design/issuing_design.rb', line 19

def updated
  @updated
end

Class Method Details

.get(id, user: nil) ⇒ Object

# Retrieve a specific IssuingDesign

Receive a single IssuingDesign object previously created in the Stark Infra API by its id

## Parameters (required):

  • id [string]: object unique id. ex: ‘5656565656565656’

## Parameters (optional):

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • IssuingDesign object with updated attributes



43
44
45
 
# File 'lib/issuing_design/issuing_design.rb', line 43

def self.get(id, user: nil)
  StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
end

.page(cursor: nil, limit: nil, status: nil, user: nil) ⇒ Object

# Retrieve paged IssuingDesigns

Receive a list of up to 100 IssuingDesign objects previously created in the Stark Infra API and the cursor to the next page. Use this function instead of query if you want to manually page your requests.

## Parameters (optional):

  • cursor [string, default nil]: cursor returned on the previous page function call.

  • limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35

  • ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: [“5656565656565656”, “4545454545454545”]

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call

## Return:

  • list of IssuingDesign objects with updated attributes

  • cursor to retrieve the next page of IssuingDesign objects



81
82
83
84
85
86
87
88
89
 
# File 'lib/issuing_design/issuing_design.rb', line 81

def self.page(cursor: nil, limit: nil, status: nil, user: nil)
  StarkInfra::Utils::Rest.get_page(
    cursor: cursor,
    limit: limit,
    status: status,
    user: user,
    **resource
  )
end

.parse_designs(designs) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/issuing_design/issuing_design.rb', line 107

def self.parse_designs(designs)
  resource_maker = StarkInfra::IssuingDesign.resource[:resource_maker]
  return designs if designs.nil?

  parsed_designs = []
  designs.each do |design|
    unless design.is_a? IssuingDesign
      design = StarkCore::Utils::API.from_api_json(resource_maker, design)
    end
    parsed_designs << design
  end
  parsed_designs
end

.pdf(id, user: nil) ⇒ Object

# Retrieve a specific IssuingDesign pdf file

Receive a single IssuingDesign pdf file generated in the Stark Infra API by its id.

## Parameters (required):

  • id [string]: object unique id. ex: ‘5656565656565656’

## Parameters (optional):

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • IssuingDesign pdf file



103
104
105
 
# File 'lib/issuing_design/issuing_design.rb', line 103

def self.pdf(id, user: nil)
  StarkInfra::Utils::Rest.get_content(id: id, user: user, sub_resource_name: 'pdf', **resource)
end

.query(limit: nil, ids: nil, user: nil) ⇒ Object

# Retrieve IssuingDesigns

Receive a generator of IssuingDesigns objects previously created in the Stark Infra API

## Parameters (optional):

  • limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35

  • ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: [“5656565656565656”, “4545454545454545”]

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if starkinfra.user was set before function call

## Return:

  • generator of IssuingDesigns objects with updated attributes



58
59
60
61
62
63
64
65
 
# File 'lib/issuing_design/issuing_design.rb', line 58

def self.query(limit: nil, ids: nil, user: nil)
  StarkInfra::Utils::Rest.get_stream(
    limit: limit,
    ids: ids,
    user: user,
    **resource
  )
end

.resource ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/issuing_design/issuing_design.rb', line 121

def self.resource
  {
    resource_name: 'IssuingDesign',
    resource_maker: proc { |json|
      IssuingDesign.new(
        id: json['id'],
        name: json['name'],
        embosser_ids: json['embosser_ids'],
        type: json['type'],
        updated: json['updated'],
        created: json['created']
      )
    }
  }
end