Class: ShipEngine::Domain::Labels

Inherits:
Object
  • Object
show all
Defined in:
lib/shipengine/domain/labels.rb,
lib/shipengine/domain/labels/void_label.rb,
lib/shipengine/domain/labels/create_from_rate.rb,
lib/shipengine/domain/labels/create_from_shipment_details.rb

Overview

rubocop:todo Metrics/ClassLength

Defined Under Namespace

Modules: CreateFromRate, CreateFromShipmentDetails, VoidLabel

Instance Method Summary collapse

Constructor Details

#initialize(internal_client) ⇒ Labels

Returns a new instance of Labels.

Parameters:



14
15
16
 
# File 'lib/shipengine/domain/labels.rb', line 14

def initialize(internal_client)
  @internal_client = internal_client
end

Instance Method Details

#create_from_rate(rate_id, params, config) ⇒ ShipEngine::Domain::Labels::CreateFromRate::Response

Parameters:

  • label_id (String)
  • params (Hash)
  • config (Hash?)

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'lib/shipengine/domain/labels.rb', line 25

def create_from_rate(rate_id, params, config)
  response = @internal_client.post("/v1/labels/rates/#{rate_id}", params, config)
  label_api_result = response.body
  mash_result = Hashie::Mash.new(label_api_result)

  shipment_cost = nil
  if mash_result.shipment_cost
    shipment_cost = CreateFromRate::Response::MonetaryValue.new(
      currency: mash_result.shipment_cost.currency,
      amount: mash_result.shipment_cost.amount
    )
  end

  insurance_cost = nil
  if mash_result.insurance_cost
    insurance_cost = CreateFromRate::Response::MonetaryValue.new(
      currency: mash_result.insurance_cost.currency,
      amount: mash_result.insurance_cost.amount
    )
  end

  label_download = nil
  if mash_result.label_download
    label_download = CreateFromRate::Response::LabelDownload.new(
      href: mash_result.label_download.href,
      pdf: mash_result.label_download.pdf,
      png: mash_result.label_download.png,
      zpl: mash_result.label_download.zpl
    )
  end

  form_download = nil
  if mash_result.form_download
    form_download = CreateFromRate::Response::FormDownload.new(
      href: mash_result.form_download.href,
      type: mash_result.form_download.type
    )
  end

  insurance_claim = nil
  if mash_result.insurance_claim
    insurance_claim = CreateFromRate::Response::InsuranceClaim.new(
      href: mash_result.insurance_claim.href,
      type: mash_result.insurance_claim.type
    )
  end

  packages = mash_result.packages.map do |package|
    weight = CreateFromRate::Response::Weight.new(
      value: package.weight.value,
      unit: package.weight.unit
    )

    dimensions = nil
    if package.dimensions
      dimensions = CreateFromRate::Response::Dimensions.new(
        unit: package.dimensions.unit,
        length: package.dimensions['length'],
        width: package.dimensions.width,
        height: package.dimensions.height
      )
    end

    insured_value = nil
    if package.insured_value
      insured_value = CreateFromRate::Response::MonetaryValue.new(
        currency: package.insured_value.currency,
        amount: package.insured_value.amount
      )
    end

    label_messages = nil
    if package.label_messages
      label_messages = CreateFromRate::Response::Package::LabelMessages.new(
        reference1: package.label_messages.reference1,
        reference2: package.label_messages.reference2,
        reference3: package.label_messages.reference3
      )
    end

    CreateFromRate::Response::Package.new(
      package_code: package.package_code,
      weight:,
      dimensions:,
      insured_value:,
      tracking_number: package.tracking_number,
      label_messages:,
      external_package_id: package.external_package_id
    )
  end

  CreateFromRate::Response.new(
    label_id: mash_result.label_id,
    status: mash_result.status,
    shipment_id: mash_result.shipment_id,
    ship_date: mash_result.ship_date,
    created_at: mash_result.created_at,
    shipment_cost:,
    insurance_cost:,
    tracking_number: mash_result.tracking_number,
    is_return_label: mash_result.is_return_label,
    rma_number: mash_result.rma_number,
    is_international: mash_result.is_international,
    batch_id: mash_result.batch_id,
    carrier_id: mash_result.carrier_id,
    charge_event: mash_result.charge_event,
    service_code: mash_result.service_code,
    package_code: mash_result.package_code,
    voided: mash_result.voided,
    voided_at: mash_result.voided_at,
    label_format: mash_result.label_format,
    display_scheme: mash_result.display_scheme,
    label_layout: mash_result.label_layout,
    trackable: mash_result.trackable,
    label_image_id: mash_result.label_image_id,
    carrier_code: mash_result.carrier_code,
    tracking_status: mash_result.tracking_status,
    label_download:,
    form_download:,
    insurance_claim:,
    packages:
  )
end

#create_from_shipment_details(params, config) ⇒ ShipEngine::Domain::Labels::CreateFromShipmentDetails::Response

Parameters:

  • params (Hash)
  • config (Hash?)

Returns:

See Also:



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/shipengine/domain/labels.rb', line 155

def create_from_shipment_details(params, config)
  response = @internal_client.post('/v1/labels', params, config)
  label_api_result = response.body
  mash_result = Hashie::Mash.new(label_api_result)

  shipment_cost = nil
  if mash_result.shipment_cost
    shipment_cost = CreateFromShipmentDetails::Response::MonetaryValue.new(
      currency: mash_result.shipment_cost.currency,
      amount: mash_result.shipment_cost.amount
    )
  end

  insurance_cost = nil
  if mash_result.insurance_cost
    insurance_cost = CreateFromShipmentDetails::Response::MonetaryValue.new(
      currency: mash_result.insurance_cost.currency,
      amount: mash_result.insurance_cost.amount
    )
  end

  label_download = nil
  if mash_result.label_download
    label_download = CreateFromShipmentDetails::Response::LabelDownload.new(
      href: mash_result.label_download.href,
      pdf: mash_result.label_download.pdf,
      png: mash_result.label_download.png,
      zpl: mash_result.label_download.zpl
    )
  end

  form_download = nil
  if mash_result.form_download
    form_download = CreateFromShipmentDetails::Response::FormDownload.new(
      href: mash_result.form_download.href,
      type: mash_result.form_download.type
    )
  end

  insurance_claim = nil
  if mash_result.insurance_claim
    insurance_claim = CreateFromShipmentDetails::Response::InsuranceClaim.new(
      href: mash_result.insurance_claim.href,
      type: mash_result.insurance_claim.type
    )
  end

  packages = mash_result.packages.map do |package|
    weight = CreateFromShipmentDetails::Response::Weight.new(
      value: package.weight.value,
      unit: package.weight.unit
    )

    dimensions = nil
    if package.dimensions
      dimensions = CreateFromShipmentDetails::Response::Dimensions.new(
        unit: package.dimensions.unit,
        length: package.dimensions['length'],
        width: package.dimensions.width,
        height: package.dimensions.height
      )
    end

    insured_value = nil
    if package.insured_value
      insured_value = CreateFromShipmentDetails::Response::MonetaryValue.new(
        currency: package.insured_value.currency,
        amount: package.insured_value.amount
      )
    end

    label_messages = nil
    if package.label_messages
      label_messages = CreateFromShipmentDetails::Response::Package::LabelMessages.new(
        reference1: package.label_messages.reference1,
        reference2: package.label_messages.reference2,
        reference3: package.label_messages.reference3
      )
    end

    CreateFromShipmentDetails::Response::Package.new(
      package_code: package.package_code,
      weight:,
      dimensions:,
      insured_value:,
      tracking_number: package.tracking_number,
      label_messages:,
      external_package_id: package.external_package_id
    )
  end

  CreateFromShipmentDetails::Response.new(
    label_id: mash_result.label_id,
    status: mash_result.status,
    shipment_id: mash_result.shipment_id,
    ship_date: mash_result.ship_date,
    created_at: mash_result.created_at,
    shipment_cost:,
    insurance_cost:,
    tracking_number: mash_result.tracking_number,
    is_return_label: mash_result.is_return_label,
    rma_number: mash_result.rma_number,
    is_international: mash_result.is_international,
    batch_id: mash_result.batch_id,
    carrier_id: mash_result.carrier_id,
    charge_event: mash_result.charge_event,
    service_code: mash_result.service_code,
    package_code: mash_result.package_code,
    voided: mash_result.voided,
    voided_at: mash_result.voided_at,
    label_format: mash_result.label_format,
    display_scheme: mash_result.display_scheme,
    label_layout: mash_result.label_layout,
    trackable: mash_result.trackable,
    label_image_id: mash_result.label_image_id,
    carrier_code: mash_result.carrier_code,
    tracking_status: mash_result.tracking_status,
    label_download:,
    form_download:,
    insurance_claim:,
    packages:
  )
end

#void(label_id, config) ⇒ ShipEngine::Domain::Labels::CreateFromShipmentDetails::Response

Parameters:

  • label_id (String)
  • config (Hash?)

Returns:

See Also:



285
286
287
288
289
290
291
292
293
294
 
# File 'lib/shipengine/domain/labels.rb', line 285

def void(label_id, config)
  response = @internal_client.put("/v1/labels/#{label_id}/void", {}, config)
  label_api_result = response.body
  mash_result = Hashie::Mash.new(label_api_result)

  VoidLabel::Response.new(
    approved: mash_result.approved,
    message: mash_result['message']
  )
end